1
0
Fork 0
mirror of https://github.com/paper-trail-gem/paper_trail.git synced 2022-11-09 11:33:19 -05:00
Commit graph

16 commits

Author SHA1 Message Date
Jared Beck
fc071b2d13 rubocop 0.41.1 (was 0.40.0) 2016-06-27 03:02:33 -04:00
Jared Beck
ad3806fcbb An idea to combat model pollution
Problem
-------

`has_paper_trail` adds too many methods to the ActiveRecord model.

> If I'm counting correctly, installing the paper_trail gem adds 36 instance
> methods and 10 class methods to all of your active record models. Of those
> 46, 13 have a prefix, either "pt_" or "paper_trail_". I don't know what the
> best way to deal with this is. Ideally, we'd add far fewer methods to
> people's models. If we were able to add fewer methods to models, then I
> wouldn't mind prefixing all of them.
> https://github.com/airblade/paper_trail/issues/703

Solution
--------

Add only two methods to the AR model.

1. An instance method `#paper_trail`
2. A class method `.paper_trail`

The instance method would return a `RecordTrail` and the class method would
return a `ClassTrail`. Those names are totally up for debate.

Advantages
----------

- Plain ruby, easy to understand
- Adding new methods to e.g. the `RecordTrail` does not add any methods to
  the AR model.
- Methods privacy is more strongly enforced.
- Enables isolated testing of e.g. `RecordTrail`; it can be constructed with a
  mock AR instance.

Disadvantages
-------------

- Two new classes, though they are simple.
2016-06-06 01:18:31 -04:00
Jared Beck
4200a6a8ca Fix Style/ParallelAssignment 2016-03-05 17:23:10 -05:00
Jared Beck
c24d0b4780 Fix whitespace 2016-03-05 17:11:08 -05:00
Jared Beck
8980f08d0e Fix Style/StringLiterals: Use double quotes 2016-03-05 17:07:32 -05:00
Jared Beck
10941c8459 Fix Style/HashSyntax 2016-02-15 22:32:40 -05:00
Jared Beck
d86e6ec64c Break long lines in spec dir 2016-02-15 18:27:57 -05:00
Owen Rodda
b9d9fb2e7c Update PaperTrail and test suite for ActiveRecord 5 compatibility 2016-01-24 19:57:10 -05:00
Jared Beck
d030ba2b02 Remove ruby 1.8 hacks
PaperTrail no longer supports ruby 1.8.
2015-12-13 01:14:59 -05:00
Jared Beck
40bf20beb5 Respect :skip re: timestamp-only updates
When attributes are ignored, either by `:ignore` or by `:skip`,
then during updates, timestamp attributes like `updated_at` should
not be considered notable changes.

[Fixes #569]
2015-07-15 22:29:19 -04:00
Ben Atkins
1b1e74dab5 Basic version comparisons for RUBY_VERSION can be done using Strings
As opposed to unnecessarily casting the RUBY_VERSION to a Float
2015-01-14 14:09:30 -05:00
Ben Atkins
be5f192bd1 close #438; PaperTrail::Model::ClassMethods#paper_trail_enabled_for_model? should return false if has_paper_trail isn't declared on the class in question 2014-10-31 10:43:24 -04:00
Ben Atkins
716c3e0fb5 Use RSpec 3 for testing; Update syntax in spec suite for RSpec 3 2014-10-09 15:04:17 -04:00
Ben Atkins
8f256d7081 Add some additional testing and comments surrounding the PaperTrail::Model::InstanceMethods#changed_notably? private method changes 2014-10-08 00:09:40 -04:00
Ben Atkins
052f16495b Update Gadget spec with Ruby18 hash syntax 2014-10-07 23:16:36 -04:00
Ben Atkins
049a86f1ab Fix PaperTrail::Model::InstanceMethods#changed_notably? to return proper values when attrs are ignored 2014-10-07 23:16:36 -04:00