Project

essay

0.0
No commit activity in last 3 years
No release in over 3 years
essayyivo/essayHomepageDocumentationSource CodeBug TrackerWiki
Feature information of activerecord models, attributes and associations
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
10,411
Stars
0
Forks
0
Watchers
2
 Releases
Current version
1.1.0
Total releases
5
First release
2016-10-20
Latest release
2016-10-23
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-02-27
Reverse Dependencies
3

 Dependencies

Runtime

activerecord
< 6.0, >= 3.0
activerecord-traits
~> 1.0
activesupport
< 6.0, >= 3.0
 Project Readme

Essay

This library provides a series of classes to obtain plugin information of ActiveRecord models.

This library is focused only on custom ActiveRecord features and will not provide information for default ActiveRecord features.

The problem

There are a lot of plugins for ActiveRecord. For example:

  • Plugins for translation (Globalize)
  • Plugins for file attachments (CarrierWave, PaperClip)
  • Plugins for safe deleting (Paranoid)
  • Plugins for taggings
  • Plugins for geocoding
  • Plugins for social networks (likes, shares etc)
  • and others...

Each of this plugins adds and/or removes and/or modifies behaviours of model. For example: adds callbacks, validations, methods, adds some imaginary meaning for attributes (good example: deleted_at when using paranoid). Each plugin uses different way of storing its options.

So, what if we need to know what plugins model is using and plugin options? ActiveRecord does not provide standardized way of developing and storing plugin options. This library provides a series of classes and utilities for creating essay writers (classes which provide information about specific ActiveRecord plugin) with unified API design.

Example for Globalize

# TODO

Gemfile

gem 'essay', github: 'yivo/essay'