annot8 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/AUTHORS.md +34 -0
- data/CHANGELOG.md +341 -0
- data/LICENSE.txt +55 -0
- data/README.md +331 -0
- data/RELEASE.md +19 -0
- data/annot8.gemspec +32 -0
- data/bin/annotate +31 -0
- data/lib/annotate/active_record_patch.rb +11 -0
- data/lib/annotate/annotate_models/file_patterns.rb +129 -0
- data/lib/annotate/annotate_models.rb +1005 -0
- data/lib/annotate/annotate_routes/header_generator.rb +117 -0
- data/lib/annotate/annotate_routes/helpers.rb +71 -0
- data/lib/annotate/annotate_routes.rb +121 -0
- data/lib/annotate/constants.rb +30 -0
- data/lib/annotate/helpers.rb +33 -0
- data/lib/annotate/parser.rb +317 -0
- data/lib/annotate/tasks.rb +8 -0
- data/lib/annotate/version.rb +7 -0
- data/lib/annotate.rb +152 -0
- data/lib/generators/annotate/USAGE +4 -0
- data/lib/generators/annotate/install_generator.rb +17 -0
- data/lib/generators/annotate/templates/auto_annotate_models.rake +63 -0
- data/lib/tasks/annotate_models.rake +79 -0
- data/lib/tasks/annotate_models_migrate.rake +65 -0
- data/lib/tasks/annotate_routes.rake +34 -0
- data/potato.md +41 -0
- metadata +120 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 67effad3a7aa5f0951ab87aa7eb4e9d57606fc56bc5468e02e956a32c28d4eec
|
4
|
+
data.tar.gz: 8f641a2f0a6c35c967493ecb589d5fd7016d0eedcc3b64f2a06b7ad69b00bde6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f8b539dbae8c70fff2958c4a65fc1cb41f178a6afa67a9d88de23042db798c3ff3f5a184d749ef388a5b6e27f4e5b22da7d4eb5d231153cac8839c364fc5a9fb
|
7
|
+
data.tar.gz: 8f85ff1c522056f684cde6951f608a0d87f2fb6bf5bfb7c777f96a444b56085fff85db877b225c5adad4adf685218c6be3fb2ac327e826faa502e0beb0df0494
|
data/AUTHORS.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
## Authors
|
2
|
+
|
3
|
+
- Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models>
|
4
|
+
- Overhauled by: Alex Chaffee <http://alexch.github.com> alex@stinky.com
|
5
|
+
- Maintained by: Alex Chaffee and Cuong Tran
|
6
|
+
- Homepage: http://github.com/chemica/annotate_models
|
7
|
+
- Forked and updated for Rails 8 by: Benjamin Dunkley - ben@chemica.co.uk
|
8
|
+
|
9
|
+
### With help from:
|
10
|
+
|
11
|
+
- Jack Danger - http://github.com/JackDanger
|
12
|
+
- Michael Bumann - http://github.com/bumi
|
13
|
+
- Henrik Nyh - http://github.com/henrik
|
14
|
+
- Marcos Piccinini - http://github.com/nofxx
|
15
|
+
- Neal Clark - http://github.com/nclark
|
16
|
+
- Jacqui Maher - http://github.com/jacqui
|
17
|
+
- Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
|
18
|
+
- Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
|
19
|
+
- Bob Potter - http://github.com/bpot
|
20
|
+
- Gavin Montague - http://github.com/govan
|
21
|
+
- Alexander Semyonov - http://github.com/rotuka
|
22
|
+
- Nathan Brazil - http://github.com/bitaxis
|
23
|
+
- Ian Duggan http://github.com/ijcd
|
24
|
+
- Jon Frisby http://github.com/mrjoy
|
25
|
+
- Tsutomu Kuroda
|
26
|
+
- Kevin Moore
|
27
|
+
- Philip Hallstrom
|
28
|
+
- Brent Greeff
|
29
|
+
- Paul Alexander
|
30
|
+
- Dmitry Lihachev
|
31
|
+
- qichunren
|
32
|
+
- Guillermo Guerrero - http://github.com/ryanfox1985
|
33
|
+
|
34
|
+
and many others that I may have forgotten to add.
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,341 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
## [1.0.0] - 2025-06-03
|
4
|
+
|
5
|
+
This is a fork of the [annotate](https://github.com/ctran/annotate_models) gem, built for Rails 8 and Ruby 3.2.2+.
|
6
|
+
|
7
|
+
### Changed
|
8
|
+
- Rename gem to "annot8"
|
9
|
+
- Update Ruby requirement to >= 3.2.2
|
10
|
+
- Update Rails/ActiveRecord requirement to >= 8.0.0
|
11
|
+
- Update repository links to point to chemica/annotate_models
|
12
|
+
- Bump gem versions
|
13
|
+
- Fix tests and linting
|
14
|
+
- Fix string literals for new Ruby versions
|
15
|
+
|
16
|
+
## 3.1.1
|
17
|
+
Changes
|
18
|
+
- Bump required ruby version to >= 2.4 [#772](https://github.com/ctran/annotate_models/pull/772)
|
19
|
+
- [Revert #677] Fix column default annotations [#768](https://github.com/ctran/annotate_models/pull/768)
|
20
|
+
|
21
|
+
Project Improvements
|
22
|
+
- Refactor by adding AnnotateRoutes::Helpers [#770](https://github.com/ctran/annotate_models/pull/770)
|
23
|
+
- Bump puma from 4.3.1 to 4.3.3 in /spec/integration/rails_6.0.2.1 [#771](https://github.com/ctran/annotate_models/pull/771)
|
24
|
+
- Bump puma from 3.12.2 to 4.3.3 in /spec/integration/rails_5.2.4.1 [#769](https://github.com/ctran/annotate_models/pull/769)
|
25
|
+
- Bump nokogiri from 1.10.7 to 1.10.8 in /spec/integration/rails_5.2.4.1 [#766](https://github.com/ctran/annotate_models/pull/766)
|
26
|
+
- Bump nokogiri from 1.10.7 to 1.10.8 in /spec/integration/rails_6.0.2.1 [#765](https://github.com/ctran/annotate_models/pull/765)
|
27
|
+
- Refactor test cases of AnnotateRoutes [#760](https://github.com/ctran/annotate_models/pull/760)
|
28
|
+
- Rename FactoryGirl -> FactoryBot comment [#759](https://github.com/ctran/annotate_models/pull/759)
|
29
|
+
|
30
|
+
## 3.1.0
|
31
|
+
Changes
|
32
|
+
- Fix new lines after comments for rubocop compatibility [#757](https://github.com/ctran/annotate_models/pull/757)
|
33
|
+
- Fix messages from AnnotateRoutes [#737](https://github.com/ctran/annotate_models/pull/737)
|
34
|
+
- Support YARD notation [#724](https://github.com/ctran/annotate_models/pull/724)
|
35
|
+
- Refactor AnnotateRoutes.routes_file_exist? [#716](https://github.com/ctran/annotate_models/pull/716)
|
36
|
+
- Refactor namespace Annotate [#719](https://github.com/ctran/annotate_models/pull/719)
|
37
|
+
- Add columns managed by Globalize gem [#602](https://github.com/ctran/annotate_models/pull/602)
|
38
|
+
|
39
|
+
Bug Fixes
|
40
|
+
- Fix additional_file_patterns parsing [#756](https://github.com/ctran/annotate_models/pull/756)
|
41
|
+
- Fix typo in README [#752](https://github.com/ctran/annotate_models/pull/752)
|
42
|
+
- Fix bin/annotate NoMethodError [#745](https://github.com/ctran/annotate_models/pull/745)
|
43
|
+
- Fix README for YARD format [#740](https://github.com/ctran/annotate_models/pull/740)
|
44
|
+
- Fix constant names that were not renamed in #721 [#739](https://github.com/ctran/annotate_models/pull/739)
|
45
|
+
- Replace soft-deprecated constant `HashWithIndifferentAccess` to `ActiveSupport::HashWithIndifferentAccess` [#699](https://github.com/ctran/annotate_models/pull/699)
|
46
|
+
- [Fix #570](https://github.com/ctran/annotate_models/issues/570) Change of foreign key should be considered as a column change
|
47
|
+
- [Fix #430](https://github.com/ctran/annotate_models/issues/430) Handle columns from activerecord-postgis-adapter [#694](https://github.com/ctran/annotate_models/pull/694)
|
48
|
+
- Add ActiveAdmin option to template [#693](https://github.com/ctran/annotate_models/pull/693)
|
49
|
+
- Fix foreign key issue with Rails 6 and Sqlite3 [#695](https://github.com/ctran/annotate_models/pull/695)
|
50
|
+
- Fix Serializers Test Directory [#625](https://github.com/ctran/annotate_models/pull/625)
|
51
|
+
- [Fix #624](https://github.com/ctran/annotate_models/issues/624) Correct default values for columns when ActiveRecord::Enum is used [#677](https://github.com/ctran/annotate_models/pull/677)
|
52
|
+
- [Fix #675](https://github.com/ctran/annotate_models/issues/675) Correct indentation for double-byte characters [#676](https://github.com/ctran/annotate_models/pull/676)
|
53
|
+
- FIX: Ensure only one line is around the annotation [#669](https://github.com/ctran/annotate_models/pull/669)
|
54
|
+
- Fix shifted when format_markdown option enabled and used non-ascii [#650](https://github.com/ctran/annotate_models/pull/650)
|
55
|
+
|
56
|
+
Project improvements
|
57
|
+
- Refactor RSpec for AnnotateModels - structuralize test cases [#755](https://github.com/ctran/annotate_models/pull/755)
|
58
|
+
- Refactor test cases of AnnotateRoutes as for Rake versions [#754](https://github.com/ctran/annotate_models/pull/754)
|
59
|
+
- Add integration tests to project [#747](https://github.com/ctran/annotate_models/pull/747)
|
60
|
+
- Refactor test cases for AnnotateRoutes.remove_annotations [#748](https://github.com/ctran/annotate_models/pull/748)
|
61
|
+
- Refactor RSpec for AnnotateModels - with Globalize gem [#749](https://github.com/ctran/annotate_models/pull/749)
|
62
|
+
- Fixed CHANGELOG.md to add link to each PR [#751](https://github.com/ctran/annotate_models/pull/751)
|
63
|
+
- Delete integration test fixtures [#746](https://github.com/ctran/annotate_models/pull/746)
|
64
|
+
- Remove remaining integration test files [#744](https://github.com/ctran/annotate_models/pull/744)
|
65
|
+
- Remove unworking integration tests [#725](https://github.com/ctran/annotate_models/pull/725)
|
66
|
+
- Refactor Annotate::Parser [#742](https://github.com/ctran/annotate_models/pull/742)
|
67
|
+
- Refactor RSpec for AnnotateModels (4) - AnnotateModels.get_schema_info (without custom options) [#735](https://github.com/ctran/annotate_models/pull/735)
|
68
|
+
- Refactor RSpec for AnnotateRoutes (1) [#736](https://github.com/ctran/annotate_models/pull/736)
|
69
|
+
- Refactor AnnotateRoutes.rewrite_contents [#734](https://github.com/ctran/annotate_models/pull/734)
|
70
|
+
- AnnotateModels.get_schema_info (with custom options) [#732](https://github.com/ctran/annotate_models/pull/732)
|
71
|
+
- Fix typo in RSpec of AnnotateModels [#731](https://github.com/ctran/annotate_models/pull/731)
|
72
|
+
- Remove AnnotateRoutes.rewrite_contents_with_header [#730](https://github.com/ctran/annotate_models/pull/730)
|
73
|
+
- Refactor AnnotateRoutes.annotate_routes and .rewrite_contents_with_header [#729](https://github.com/ctran/annotate_models/pull/729)
|
74
|
+
- Refactor AnnotateModels::Parser [#728](https://github.com/ctran/annotate_models/pull/728)
|
75
|
+
- Remove invalid document of AnnotateRoutes.rewrite_contents [#727](https://github.com/ctran/annotate_models/pull/727)
|
76
|
+
- Refactor RSpec for AnnotateModels (1) [#726](https://github.com/ctran/annotate_models/pull/726)
|
77
|
+
- Refactor AnnotateModels::Helpers [#723](https://github.com/ctran/annotate_models/pull/723)
|
78
|
+
- Refactor AnnotateRoutes.remove_annotations [#715](https://github.com/ctran/annotate_models/pull/715)
|
79
|
+
- Fix AnnotateRoutes.extract_magic_comments_from_array [#712](https://github.com/ctran/annotate_models/pull/712)
|
80
|
+
- Rename FactoryGirl to FactoryBot [#721](https://github.com/ctran/annotate_models/pull/721)
|
81
|
+
- Refactor AnnotateRoutes.header [#714](https://github.com/ctran/annotate_models/pull/714)
|
82
|
+
- Freeze constant AnnotateRoutes::HEADER_ROW [#713](https://github.com/ctran/annotate_models/pull/713)
|
83
|
+
- Add constants MAGIC_COMMENT_MATCHER [#711](https://github.com/ctran/annotate_models/pull/711)
|
84
|
+
- Rename method and variable of AnnotateRoutes for readability [#709](https://github.com/ctran/annotate_models/pull/709)
|
85
|
+
- Refactor lib/annotate.rb [#707](https://github.com/ctran/annotate_models/pull/707)
|
86
|
+
- Delete TODO.md [#700](https://github.com/ctran/annotate_models/pull/700)
|
87
|
+
- Tidy README [#701](https://github.com/ctran/annotate_models/pull/701)
|
88
|
+
- Convert documentation files to Markdown [#697](https://github.com/ctran/annotate_models/pull/697)
|
89
|
+
- Upgrade and fix CI [#698](https://github.com/ctran/annotate_models/pull/698)
|
90
|
+
- Add upgrade instructions to README [#687](https://github.com/ctran/annotate_models/pull/687)
|
91
|
+
- Fix Github release action [#682](https://github.com/ctran/annotate_models/pull/682)
|
92
|
+
|
93
|
+
## 3.0.3
|
94
|
+
- Use a less error-prone way of specifying gem files [#662](https://github.com/ctran/annotate_models/pull/662)
|
95
|
+
- Update rake requirement from `>= 10.4, < 13.0` to `>= 10.4, < 14.0` [#659](https://github.com/ctran/annotate_models/pull/659)
|
96
|
+
- Bump nokogiri from 1.6.6.2 to 1.10.4 in /spec/integration/rails_4.2.0 [#655](https://github.com/ctran/annotate_models/pull/655)
|
97
|
+
- Default annotate models to true in config generated by `rails g annotate:install` [#671](https://github.com/ctran/annotate_models/pull/671)
|
98
|
+
- Bump loofah from 2.3.0 to 2.3.1 in /spec/integration/rails_4.2.0 [#681](https://github.com/ctran/annotate_models/pull/681)
|
99
|
+
|
100
|
+
## 3.0.2
|
101
|
+
- Fixes `LoadError` due to gemspec not referencing `parser.rb`, issue [#657](https://github.com/ctran/annotate_models/issues/657) [#660](https://github.com/ctran/annotate_models/pull/660)
|
102
|
+
- Changes `--additional_file_patterns` to use dashes `--additional-file-patterns` for consistency [#649](https://github.com/ctran/annotate_models/pull/649)
|
103
|
+
- Refactor: moving constants into `constants.rb` [#653](https://github.com/ctran/annotate_models/pull/653)
|
104
|
+
|
105
|
+
## 3.0.1
|
106
|
+
- Skipped as an official release, used the 3.0.1 patch for setting up Github Actions [#619](https://github.com/ctran/annotate_models/pull/619)
|
107
|
+
|
108
|
+
## 3.0.0
|
109
|
+
- **Breaking:** when option `models` is not set - models will not be annotated by default.
|
110
|
+
|
111
|
+
Add `'models'=>'true'` to your config manually or use `--models` option if using CLI.
|
112
|
+
|
113
|
+
- Added `--models` CLI option fixing issue [#563](https://github.com/ctran/annotate_models/issues/563) [#647](https://github.com/ctran/annotate_models/pull/647)
|
114
|
+
- Added `--additional_file_patterns` option for additional file patterns [#633](https://github.com/ctran/annotate_models/pull/633) [#636](https://github.com/ctran/annotate_models/pull/636) [#637](https://github.com/ctran/annotate_models/pull/637)
|
115
|
+
- Refactored CLI parser [#646](https://github.com/ctran/annotate_models/pull/646)
|
116
|
+
- Fixed `BigDecimal.new` deprecation warning [#634](https://github.com/ctran/annotate_models/pull/634)
|
117
|
+
- Fixed annotations for columns with long data types [#622](https://github.com/ctran/annotate_models/pull/622)
|
118
|
+
- Made methods private in AnnotateRoutes [#598](https://github.com/ctran/annotate_models/pull/598)
|
119
|
+
|
120
|
+
See https://github.com/ctran/annotate_models/releases/tag/v3.0.0
|
121
|
+
|
122
|
+
## 2.7.5
|
123
|
+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.5
|
124
|
+
|
125
|
+
## 2.7.3
|
126
|
+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.3
|
127
|
+
|
128
|
+
## 2.7.2
|
129
|
+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.2
|
130
|
+
|
131
|
+
## 2.7.1
|
132
|
+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.1
|
133
|
+
|
134
|
+
## 2.7.0
|
135
|
+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.0
|
136
|
+
|
137
|
+
## 2.6.9
|
138
|
+
- Support foreigh key [#241](https://github.com/ctran/annotate_models/pull/241)
|
139
|
+
- Check if model has skip tag in annotate_model_file [#167](https://github.com/ctran/annotate_models/pull/167)
|
140
|
+
- Fix issue where serializer-related flags weren't being honored [#246](https://github.com/ctran/annotate_models/issues/246)
|
141
|
+
- Prefer SQL column type over normalized AR type [#231](https://github.com/ctran/annotate_models/issues/231)
|
142
|
+
|
143
|
+
## 2.6.8
|
144
|
+
- Nothing annotated unless `options[:model_dir]` is specified, [#234](https://github.com/ctran/annotate_models/pull/234)
|
145
|
+
|
146
|
+
## 2.6.7
|
147
|
+
- Nothing annotated unless `options[:model_dir]` is specified, [#234](https://github.com/ctran/annotate_models/pull/234)
|
148
|
+
|
149
|
+
## 2.6.6
|
150
|
+
- Makes it possible to wrap annotations, [#225](https://github.com/ctran/annotate_models/pull/225)
|
151
|
+
- Fix single model generation, [#214](https://github.com/ctran/annotate_models/pull/214)
|
152
|
+
- Fix default value for Rails 4.2, [#212](https://github.com/ctran/annotate_models/issues/212)
|
153
|
+
- Don't crash on inherited models in subdirectories, [#232](https://github.com/ctran/annotate_models/issues/232)
|
154
|
+
- Process model_dir in rake task, [#197](https://github.com/ctran/annotate_models/pull/197)
|
155
|
+
|
156
|
+
## 2.6.4
|
157
|
+
- Skip "models/concerns", [#194](https://github.com/ctran/annotate_models/pull/194)
|
158
|
+
- Fix [#173](https://github.com/ctran/annotate_models/issues/173) where annotate says "Nothing to annotate" in rails 4.2
|
159
|
+
- Display an error message if not run from the root of the project, [#186](https://github.com/ctran/annotate_models/pull/186)
|
160
|
+
- Support rails 4.0 new default test directory, [#182](https://github.com/ctran/annotate_models/issues/182)
|
161
|
+
- Add an option to show timestamp in routes "-timestamp", [#136](https://github.com/ctran/annotate_models/issues/136)
|
162
|
+
- Skip plain ruby objects if they have the same class name as an ActiveRecord object, [#121](https://github.com/ctran/annotate_models/issues/121)
|
163
|
+
|
164
|
+
## 2.6.3
|
165
|
+
- Fix bug of annotate position in routes [#158](https://github.com/ctran/annotate_models/issues/158)
|
166
|
+
|
167
|
+
## 2.6.2
|
168
|
+
- Retain the current annotate block unless --force is specified
|
169
|
+
- Always load models, since they may not be autoloaded by Rails
|
170
|
+
- The pg array type is now detected (see [#158](https://github.com/ctran/annotate_models/pull/158))
|
171
|
+
|
172
|
+
## 2.6.0.beta2
|
173
|
+
- support for composite_primary_keys (garysweaver)
|
174
|
+
- bug fix for annotate_one_file (vlado)
|
175
|
+
|
176
|
+
|
177
|
+
## 2.6.0.beta1
|
178
|
+
|
179
|
+
- It's now possible to use Annotate in standalone ActiveRecord (non-Rails) projects again.
|
180
|
+
- Adding note that Markdown is actually MultiMarkdown, and recommending the use
|
181
|
+
of the `kramdown` engine for parsing it.
|
182
|
+
- Improved Markdown formatting considerably.
|
183
|
+
- Bugfix: Needed to use inline-code tag for column and table names,
|
184
|
+
otherwise underscores would cause havok with the formatting.
|
185
|
+
- Bugfix: Markdown syntax was incorrect
|
186
|
+
(can't have trailing spaces before the closing marker for an emphasis tag).
|
187
|
+
- Bugfix: Remove-annotations wasn't properly finding test/spec files,
|
188
|
+
and wasn't even looking for FactoryGirl factories under the new naming convention.
|
189
|
+
- Bugfix: Load the Rakefile from the current directory, not the first
|
190
|
+
Rakefile in our load path.
|
191
|
+
- Added support for new FactoryGirl naming convention.
|
192
|
+
- Fix behavior of route annotations in newer versions of Rake that don't
|
193
|
+
spit out the CWD as their first line of output.
|
194
|
+
- Overhauled integration testing system to be much easier to work with,
|
195
|
+
better compartmentalized, and so forth -- at the cost that you must be
|
196
|
+
using RVM to utilize it. (It'll spit out appropriate pending messages if
|
197
|
+
you don't.) Also includes a mode for "tinkering" by hand with a scenario,
|
198
|
+
and won't let you run it through rspect if the repo is in a dirty state.
|
199
|
+
Added appropriate rake tasks to help with all of this.
|
200
|
+
- Routes can now be appended, pre-pended, or removed -- and do sane things in all cases.
|
201
|
+
- Expose all `position_*` variables as CLI params.
|
202
|
+
- Make `ENV ['position']` work as a default for all the `ENV ['position_*']` variables.
|
203
|
+
- Make rake tasks more resilient to unusual circumstances / code loading behavior.
|
204
|
+
- Resolve annotate vs. annotate_models ambiguity once and for all by
|
205
|
+
settling on `annotate_models` *and* `annotate_routes`. This avoids a name
|
206
|
+
collision with RMagick while not needlessly overloading the term.
|
207
|
+
- Fixed that schema kept prepending additional newlines
|
208
|
+
- Updates to make annotate smarter about when to touch a model
|
209
|
+
- Recognize column+type, and don't change a file unless the column+type
|
210
|
+
combination of the new schema are different than that of the old (i.e.,
|
211
|
+
don't regenerate if columns happen to be in a different order. That's just
|
212
|
+
how life is sometimes)
|
213
|
+
- Change annotate to use options hash instead of ENV.
|
214
|
+
|
215
|
+
|
216
|
+
## 2.5.0
|
217
|
+
|
218
|
+
- Works better with Rails 3
|
219
|
+
- Bugfix: schema kept prepending additional newlines
|
220
|
+
- Updates to make annotate smarter about when to touch a model
|
221
|
+
- Recognize column+type, and don't change a file unless the column+type
|
222
|
+
combination of the new schema are different than that of the old (i.e.,
|
223
|
+
don't regenerate if columns happen to be in a different order. That's just
|
224
|
+
how life is sometimes.)
|
225
|
+
- Grab old specification even if it has `\r\n` as line endings rather than pure `\n`s
|
226
|
+
- Various warning and specification fixes
|
227
|
+
- Fix "no such file to load -- annotate/annotate_models (MissingSourceFile)"
|
228
|
+
error (require statements in tasks now use full path to lib files)
|
229
|
+
- warn about macros, to mitigate when we're included during a production
|
230
|
+
run, not just a rakefile run -- possibly at the expense of too much noise
|
231
|
+
- Adding rake as a runtime dependency
|
232
|
+
- If the schema is already in the model file, it will be replaced into the same location.
|
233
|
+
If it didn't previously exist, it'll be placed according to the "position", as before.
|
234
|
+
- Allow task loading from Rakefile for gems (plugin installation already auto-detects).
|
235
|
+
- Add skip_on_db_migrate option as well for people that don't want it
|
236
|
+
- Fix options parsing to convert strings to proper booleans
|
237
|
+
- Add support for Fabrication fabricators
|
238
|
+
- Leave magic encoding comment intact
|
239
|
+
- Fix issue #14 - RuntimeError: Already memoized
|
240
|
+
- Count a model as 'annotated' if any of its tests/fixtures are annotated
|
241
|
+
- Support FactoryGirl
|
242
|
+
- Support :change migrations (Rails 3.1)
|
243
|
+
- Allow models with non-standard capitalization
|
244
|
+
- Widen type column so we can handle longtexts with chopping things off.
|
245
|
+
- Skip trying to get list of models from commandline when running via Rake
|
246
|
+
(was preventing the use of multiple rake tasks in one command if one of them was `db:migrate`).
|
247
|
+
- Add ability to skip annotations for a model by adding
|
248
|
+
`# -*- SkipSchemaAnnotations` anywhere in the file.
|
249
|
+
- Don't show column limits for integer and boolean types.
|
250
|
+
- Add sorting for columns and indexes.
|
251
|
+
(Helpful for out-of-order migration execution. Use `--sort` if you want this.)
|
252
|
+
- Annotate unit tests in subfolders.
|
253
|
+
- Add generator to install rakefile that automatically annotates on `db:migrate`.
|
254
|
+
- Correct Gemfile to clarify which environments need which gems.
|
255
|
+
- Add an .rvmrc to facilitate clean development.
|
256
|
+
- Refactor out ActiveRecord monkey-patch to permit extending without side-effects.
|
257
|
+
- Use ObjectSpace to locate models to facilitate handling of models with
|
258
|
+
non-standard capitalization.
|
259
|
+
Note that this still requires that the inflector be configured to understand
|
260
|
+
the special case.
|
261
|
+
- Shore up test cases a bit.
|
262
|
+
- Merge against many of the older branches on Github whose functionality is
|
263
|
+
already reflected to reduce confusion about what is and is not implemented here.
|
264
|
+
- Accept String or Symbol for :position (et al) options.
|
265
|
+
- Add RDoc output formatting as an option.
|
266
|
+
- Add Markdown output formatting as an option.
|
267
|
+
- Add option to force annotation regeneration.
|
268
|
+
- Add new configuration option for controlling where info is placed in
|
269
|
+
fixtures/factories.
|
270
|
+
- Fix for models without tables.
|
271
|
+
- Fix gemspec generation now that Jeweler looks at Gemfile.
|
272
|
+
- Fix warning: `NOTE: Gem::Specification#default_executable= is deprecated
|
273
|
+
with no replacement. It will be removed on or after 2011-10-01.`
|
274
|
+
- Fix handling of files with no trailing newline when putting annotations at
|
275
|
+
the end of the file.
|
276
|
+
- Now works on tables with no primary key.
|
277
|
+
- `--format=markdown` option
|
278
|
+
- `--trace` option to help debug "Unable to annotate" errors
|
279
|
+
- "Table name" annotation (if table name is different from model name)
|
280
|
+
- "Human name" annotation (enabling translation to non-English locales)
|
281
|
+
- Fix JRuby ObjectSpace compatibility bug (https://github.com/ctran/annotate_models/pull/85)
|
282
|
+
- Fix FactoryGirl compatibility bug (https://github.com/ctran/annotate_models/pull/82)
|
283
|
+
|
284
|
+
|
285
|
+
## 2.4.2 2009-11-21
|
286
|
+
- Annotates `(spec|test)/factories/<model>_factory.rb` files
|
287
|
+
|
288
|
+
## 2.4.1 2009-11-20
|
289
|
+
|
290
|
+
- Annotates thoughtbot's factory_girl factories (`test/factories/<model>_factory.rb`)
|
291
|
+
- Move default annotation position back to top
|
292
|
+
|
293
|
+
|
294
|
+
## 2.4.0 2009-12-13
|
295
|
+
- Incorporated lots of patches from the Github community,
|
296
|
+
including support for Blueprints fixtures
|
297
|
+
- Several bug fixes
|
298
|
+
|
299
|
+
## 2.1 2009-10-18
|
300
|
+
|
301
|
+
- New options
|
302
|
+
- `-R` to require additional files before loading the models
|
303
|
+
- `-i` to show database indexes in annotations
|
304
|
+
- `-e` to exclude annotating tests or fixtures
|
305
|
+
- `-m` to include the migration version number in the annotation
|
306
|
+
- `--model-dir` to annotate model files stored a different place than `app/models`
|
307
|
+
|
308
|
+
- Ignore unknown macros ('acts_as_whatever')
|
309
|
+
|
310
|
+
|
311
|
+
## 2.0 2009-02-03
|
312
|
+
|
313
|
+
- Add annotate_models plugin fork additions
|
314
|
+
- Annotates Rspec and Test Unit models
|
315
|
+
- Annotates Object Daddy exemplars
|
316
|
+
- Annotates geometrical columns
|
317
|
+
|
318
|
+
- Add AnnotateRoutes rake task
|
319
|
+
- Up gem structure to newgem defaults
|
320
|
+
|
321
|
+
|
322
|
+
## 1.0.4 2008-09-04
|
323
|
+
|
324
|
+
- Only update modified models since last run, thanks to sant0sk1
|
325
|
+
|
326
|
+
## 1.0.3 2008-05-02
|
327
|
+
|
328
|
+
- Add misc changes from Dustin Sallings and Henrik N
|
329
|
+
- Remove trailing whitespace
|
330
|
+
- More intuitive info messages
|
331
|
+
- Update README file with update-to-date example
|
332
|
+
|
333
|
+
## 1.0.2 2008-03-22
|
334
|
+
|
335
|
+
- Add contributions from Michael Bumann (http://github.com/bumi)
|
336
|
+
- added an option "position" to choose to put the annotation,
|
337
|
+
- spec/fixtures now also get annotated
|
338
|
+
- added a task to remove the annotations
|
339
|
+
- these options can be specified from command line as `-d` and `-p [before|after]`
|
340
|
+
|
341
|
+
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
You can redistribute it and/or modify it under either the terms of the
|
2
|
+
2-clause BSDL (see the file BSDL), or the conditions below:
|
3
|
+
|
4
|
+
1. You may make and give away verbatim copies of the source form of the
|
5
|
+
software without restriction, provided that you duplicate all of the
|
6
|
+
original copyright notices and associated disclaimers.
|
7
|
+
|
8
|
+
2. You may modify your copy of the software in any way, provided that
|
9
|
+
you do at least ONE of the following:
|
10
|
+
|
11
|
+
a) place your modifications in the Public Domain or otherwise
|
12
|
+
make them Freely Available, such as by posting said
|
13
|
+
modifications to Usenet or an equivalent medium, or by allowing
|
14
|
+
the author to include your modifications in the software.
|
15
|
+
|
16
|
+
b) use the modified software only within your corporation or
|
17
|
+
organization.
|
18
|
+
|
19
|
+
c) give non-standard binaries non-standard names, with
|
20
|
+
instructions on where to get the original software distribution.
|
21
|
+
|
22
|
+
d) make other distribution arrangements with the author.
|
23
|
+
|
24
|
+
3. You may distribute the software in object code or binary form,
|
25
|
+
provided that you do at least ONE of the following:
|
26
|
+
|
27
|
+
a) distribute the binaries and library files of the software,
|
28
|
+
together with instructions (in the manual page or equivalent)
|
29
|
+
on where to get the original distribution.
|
30
|
+
|
31
|
+
b) accompany the distribution with the machine-readable source of
|
32
|
+
the software.
|
33
|
+
|
34
|
+
c) give non-standard binaries non-standard names, with
|
35
|
+
instructions on where to get the original software distribution.
|
36
|
+
|
37
|
+
d) make other distribution arrangements with the author.
|
38
|
+
|
39
|
+
4. You may modify and include the part of the software into any other
|
40
|
+
software (possibly commercial). But some files in the distribution
|
41
|
+
are not written by the author, so that they are not under these terms.
|
42
|
+
|
43
|
+
For the list of those files and their copying conditions, see the
|
44
|
+
file LEGAL.
|
45
|
+
|
46
|
+
5. The scripts and library files supplied as input to or produced as
|
47
|
+
output from the software do not automatically fall under the
|
48
|
+
copyright of the software, but belong to whomever generated them,
|
49
|
+
and may be sold commercially, and may be aggregated with this
|
50
|
+
software.
|
51
|
+
|
52
|
+
6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
|
53
|
+
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
|
54
|
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
55
|
+
PURPOSE.
|