kotovalexarian-likes-github
/
paper-trail-gem--paper_trail
mirror of https://github.com/paper-trail-gem/paper_trail.git
1
0
Fork 0
Code Releases Activity
paper-trail-gem--paper_trail/.rubocop_todo.yml

20 lines
331 B
YAML
Raw Normal View History

Break long lines in `test` dir
2016-02-15 23:13:45 +00:00
# Remove these configuration records
Run rubocop linter before test suite Most of the "cops" are wholly or partially disabled at this point. As offenses are fixed, cops will move from `.rubocop_todo.yml` to `.rubocop.yml`. See https://github.com/bbatsov/rubocop#automatically-generated-configuration for details.
2015-11-28 02:16:37 +00:00
# one by one as the offenses are removed from the code base.
Metrics/AbcSize:
Extract private method init_unversioned_attrs
2016-04-26 05:56:23 +00:00
Max: 30 # Goal: 15
Run rubocop linter before test suite Most of the "cops" are wholly or partially disabled at this point. As offenses are fixed, cops will move from `.rubocop_todo.yml` to `.rubocop.yml`. See https://github.com/bbatsov/rubocop#automatically-generated-configuration for details.
2015-11-28 02:16:37 +00:00
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-02-23 22:59:14 +00:00
Metrics/ClassLength:
rubocop 0.41.1 (was 0.40.0)
2016-06-27 07:02:33 +00:00
Max: 327
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-02-23 22:59:14 +00:00
Exclude:
- test/**/*
Run rubocop linter before test suite Most of the "cops" are wholly or partially disabled at this point. As offenses are fixed, cops will move from `.rubocop_todo.yml` to `.rubocop.yml`. See https://github.com/bbatsov/rubocop#automatically-generated-configuration for details.
2015-11-28 02:16:37 +00:00
Metrics/CyclomaticComplexity:
rubocop 0.41.1 (was 0.40.0)
2016-06-27 07:02:33 +00:00
Max: 8 # Goal: 6
Run rubocop linter before test suite Most of the "cops" are wholly or partially disabled at this point. As offenses are fixed, cops will move from `.rubocop_todo.yml` to `.rubocop.yml`. See https://github.com/bbatsov/rubocop#automatically-generated-configuration for details.
2015-11-28 02:16:37 +00:00
Metrics/ModuleLength:
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-02-23 22:59:14 +00:00
Max: 317
Run rubocop linter before test suite Most of the "cops" are wholly or partially disabled at this point. As offenses are fixed, cops will move from `.rubocop_todo.yml` to `.rubocop.yml`. See https://github.com/bbatsov/rubocop#automatically-generated-configuration for details.
2015-11-28 02:16:37 +00:00
Metrics/PerceivedComplexity:
rubocop 0.41.1 (was 0.40.0)
2016-06-27 07:02:33 +00:00
Max: 10 # Goal: 7