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