Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pikachuexe/active_record_tweaks
Active Record is great, but could be better. Here are some tweaks for it.
https://github.com/pikachuexe/active_record_tweaks
Last synced: 25 days ago
JSON representation
Active Record is great, but could be better. Here are some tweaks for it.
- Host: GitHub
- URL: https://github.com/pikachuexe/active_record_tweaks
- Owner: PikachuEXE
- License: mit
- Created: 2013-11-04T01:39:29.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T00:47:26.000Z (3 months ago)
- Last Synced: 2024-10-13T15:13:48.735Z (about 1 month ago)
- Language: Ruby
- Size: 86.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Active Record Tweaks
Active Record is great, but could be better. Here are some tweaks for it.
## Status
[](https://github.com/PikachuEXE/active_record_tweaks/actions/workflows/tests.yaml)
[](http://badge.fury.io/rb/active_record_tweaks)
[](http://badge.fury.io/rb/active_record_tweaks)
[](https://coveralls.io/r/PikachuEXE/active_record_tweaks)
[](https://codeclimate.com/github/PikachuEXE/active_record_tweaks)
> The above badges are generated by https://shields.io/
## Installation
```ruby
gem 'active_record_tweaks'
```
## Usage
Either include it in specific record or just `ActiveRecord::Base`
```ruby
class SomeRecord
include ActiveRecordTweaks::Integration::InstanceMethods
# This module is also DEPRECATED
# See below for details
extend ActiveRecordTweaks::Integration::ClassMethods
# DEPRECATED
include ActiveRecordTweaks
end
# or
# In a initialzer
# DEPRECATED
ActiveRecord::Base.send(:include, ActiveRecordTweaks)
```
### `#cache_key_without_timestamp`
Nothing special, just like `record.cache_key`
But it has no timestamp so you can use it for scoped cache key
e.g. When caching with Cookie, which you want to control the expiry time independent of record update time
Usage:
```ruby
# Just like using #cache_key
record.cache_key_without_timestamp
```
### `#cache_key_from_attributes`
Nothing special, just like `record.cache_key` in rails 4.1
But it does not check against columns
e.g. When you have some virtual timestamp attribute method (cached or not)
Just make sure you throw some name to it or it will raise error
Alias: `#cache_key_from_attribute`
Usage:
```ruby
# Just like using #cache_key
record.cache_key_from_attributes(:happy_at, :children_max_updated_at)
```
### `.cache_key`
**DEPRECATED**
This method does NOT consider the query like filters and and sort orders.
Thus deprecated without replacement.
Rails 5 already have `#cache_key` in relation class: https://github.com/rails/rails/pull/20884
There is also a gem for older rails: https://github.com/customink/activerecord-collection_cache_key
**Usage**
There is no class level cache key for ActiveRecord at the moment (4.0.1)
Passing an array to `cache_digest` could lead to performance issue and the key can become too long when collection is big
([rails#12726](https://github.com/rails/rails/pull/12726))
This is used for getting a cache key for a ActiveRecord class for all record (I don't know how to write one for `Relation`, could be similar)
You can use it for class level caching (like displaying all Categories or a random list of 5 users
And the cache would only expire when there is any record created, updated, or deleted (since `count` and maximum of `updated_at` are used)
```ruby
Person.count # => 1000
Person.maximum(:updated_at) # => 20131106012125528738000
Person.cache_key # => "people/all/1000-20131106012125528738000"
# When record has multiple updated columns
Person.maximum(:updated_at) # => 20131106012125528738000
Person.maximum(:updated_on) # => 20141106012125528738000
Person.cache_key(:update_at, :updated_on) # => "people/all/1000-20141106012125528738000" (not empty but has mutiple updated timestamp columns)
# Just get cache key without timestamp
Person.maximum(:updated_on) # => some timestamp
Person.cache_key(nil) # => "people/all/1000"
# Other examples
Product.cache_key # => "products/all/0" (empty, has updated timestamp columns or not)
Product.cache_key # => "products/all/1" (not empty but has no updated timestamp columns)
```
Usage:
```ruby
RecordClass.cache_key
```
You can also use it with multiple records (Rails 4 Record might have `updated_at` and `updated_on`)
```ruby
RecordClass.cache_key(:updated_at, :updated_on)
```
### `.cache_key_without_timestamp`
**DEPRECATED**
Same deprecation reasons and replacement suggestion as `.cache_key` above
**Usage**
Just like `.cache_key(nil)`
But much clearer
```ruby
Person.count # => 1000
Person.maximum(:updated_at) # => 20131106012125528738000
Person.cache_key_without_timestamp # => "people/all/1000"
# Other examples
Product.cache_key_without_timestamp # => "products/all/0" (empty, has updated timestamp columns or not)
Product.cache_key_without_timestamp # => "products/all/1" (not empty but has no updated timestamp columns)
```
Usage:
```ruby
RecordClass.cache_key_without_timestamp
```