Skip to content

Commit cb09e6a

Browse files
Vasfeddrwl
Vasfed
authored and
drwl
committed
Convert documentation files to Markdown (#697)
* Convert documentation files to Markdown * Add notice about models not being annotated by default to changelog in 3.0
1 parent d16182f commit cb09e6a

10 files changed

+413
-393
lines changed

‎.document

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
spec/**/*.rb
22
lib/**/*.rb
33
-
4-
README.rdoc
5-
CHANGELOG.rdoc
6-
TODO.rdoc
4+
README.md
5+
CHANGELOG.md
6+
TODO.md

‎AUTHORS.rdoc ‎AUTHORS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
== Authors
1+
## Authors
22

33
- Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models>
44
- Overhauled by: Alex Chaffee <http://alexch.github.com> [email protected]
55
- Gemmed by: Cuong Tran <http://github.com/ctran> [email protected]
66
- Maintained by: Alex Chaffee and Cuong Tran
77
- Homepage: http://github.com/ctran/annotate_models
88

9-
With help from:
9+
### With help from:
1010

1111
- Jack Danger - http://github.com/JackDanger
1212
- Michael Bumann - http://github.com/bumi

‎CHANGELOG.md

+249
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
## 3.0.3
2+
- Use a less error-prone way of specifying gem files (#662)
3+
- Update rake requirement from `>= 10.4, < 13.0` to `>= 10.4, < 14.0` (#659)
4+
- Bump nokogiri from 1.6.6.2 to 1.10.4 in /spec/integration/rails_4.2.0 (#655)
5+
- Default annotate models to true in config generated by `rails g annotate:install` (#671)
6+
- Bump loofah from 2.3.0 to 2.3.1 in /spec/integration/rails_4.2.0 (#681)
7+
8+
## 3.0.2
9+
- Fixes `LoadError` due to gemspec not referencing `parser.rb`, issue #657 (#660)
10+
- Changes `--additional_file_patterns` to use dashes `--additional-file-patterns` for consistency (#649)
11+
- Refactor: moving constants into `constants.rb` (#653)
12+
13+
## 3.0.1
14+
- Skipped as an official release, used the 3.0.1 patch for setting up Github Actions (#619)
15+
16+
## 3.0.0
17+
- **Breaking:** when option `models` is not set - models will not be annotated by default.
18+
19+
Add `'models'=>'true'` to your config manually or use `--models` option if using CLI.
20+
21+
- Added `--models` CLI option fixing issue #563 (#647)
22+
- Added `--additional_file_patterns` option for additional file patterns (#633) (#636) (#637)
23+
- Refactored CLI parser (#646)
24+
- Fixed `BigDecimal.new` deprecation warning (#634)
25+
- Fixed annotations for columns with long data types (#622)
26+
- Made methods private in AnnotateRoutes (#598)
27+
28+
See https://github.com/ctran/annotate_models/releases/tag/v3.0.0
29+
30+
## 2.7.5
31+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.5
32+
33+
## 2.7.3
34+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.3
35+
36+
## 2.7.2
37+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.2
38+
39+
## 2.7.1
40+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.1
41+
42+
## 2.7.0
43+
See https://github.com/ctran/annotate_models/releases/tag/v2.7.0
44+
45+
## 2.6.9
46+
- Support foreigh key (#241)
47+
- Check if model has skip tag in annotate_model_file (#167)
48+
- Fix issue where serializer-related flags weren't being honored (#246)
49+
- Prefer SQL column type over normalized AR type (#231)
50+
51+
## 2.6.8
52+
- Nothing annotated unless `options[:model_dir]` is specified, #234
53+
54+
## 2.6.7
55+
- Nothing annotated unless `options[:model_dir]` is specified, #234
56+
57+
## 2.6.6
58+
- Makes it possible to wrap annotations, #225
59+
- Fix single model generation, #214
60+
- Fix default value for Rails 4.2, #212
61+
- Don't crash on inherited models in subdirectories, #232
62+
- Process model_dir in rake task, #197
63+
64+
## 2.6.4
65+
- Skip "models/concerns", #194
66+
- Fix #173 where annotate says "Nothing to annotate" in rails 4.2
67+
- Display an error message if not run from the root of the project, #186
68+
- Support rails 4.0 new default test directory, #182
69+
- Add an option to show timestamp in routes "-timestamp", #136
70+
- Skip plain ruby objects if they have the same class name as an ActiveRecord object, #121
71+
72+
## 2.6.3
73+
- Fix bug of annotate position in routes (#158)
74+
75+
## 2.6.2
76+
- Retain the current annotate block unless --force is specified
77+
- Always load models, since they may not be autoloaded by Rails
78+
- The pg array type is now detected (see #158)
79+
80+
## 2.6.0.beta2
81+
- support for composite_primary_keys (garysweaver)
82+
- bug fix for annotate_one_file (vlado)
83+
84+
85+
## 2.6.0.beta1
86+
87+
- It's now possible to use Annotate in standalone ActiveRecord (non-Rails) projects again.
88+
- Adding note that Markdown is actually MultiMarkdown, and recommending the use
89+
of the `kramdown` engine for parsing it.
90+
- Improved Markdown formatting considerably.
91+
- Bugfix: Needed to use inline-code tag for column and table names,
92+
otherwise underscores would cause havok with the formatting.
93+
- Bugfix: Markdown syntax was incorrect
94+
(can't have trailing spaces before the closing marker for an emphasis tag).
95+
- Bugfix: Remove-annotations wasn't properly finding test/spec files,
96+
and wasn't even looking for FactoryGirl factories under the new naming convention.
97+
- Bugfix: Load the Rakefile from the current directory, not the first
98+
Rakefile in our load path.
99+
- Added support for new FactoryGirl naming convention.
100+
- Fix behavior of route annotations in newer versions of Rake that don't
101+
spit out the CWD as their first line of output.
102+
- Overhauled integration testing system to be much easier to work with,
103+
better compartmentalized, and so forth -- at the cost that you must be
104+
using RVM to utilize it. (It'll spit out appropriate pending messages if
105+
you don't.) Also includes a mode for "tinkering" by hand with a scenario,
106+
and won't let you run it through rspect if the repo is in a dirty state.
107+
Added appropriate rake tasks to help with all of this.
108+
- Routes can now be appended, pre-pended, or removed -- and do sane things in all cases.
109+
- Expose all `position_*` variables as CLI params.
110+
- Make `ENV ['position']` work as a default for all the `ENV ['position_*']` variables.
111+
- Make rake tasks more resilient to unusual circumstances / code loading behavior.
112+
- Resolve annotate vs. annotate_models ambiguity once and for all by
113+
settling on `annotate_models` *and* `annotate_routes`. This avoids a name
114+
collision with RMagick while not needlessly overloading the term.
115+
- Fixed that schema kept prepending additional newlines
116+
- Updates to make annotate smarter about when to touch a model
117+
- Recognize column+type, and don't change a file unless the column+type
118+
combination of the new schema are different than that of the old (i.e.,
119+
don't regenerate if columns happen to be in a different order. That's just
120+
how life is sometimes)
121+
- Change annotate to use options hash instead of ENV.
122+
123+
124+
## 2.5.0
125+
126+
- Works better with Rails 3
127+
- Bugfix: schema kept prepending additional newlines
128+
- Updates to make annotate smarter about when to touch a model
129+
- Recognize column+type, and don't change a file unless the column+type
130+
combination of the new schema are different than that of the old (i.e.,
131+
don't regenerate if columns happen to be in a different order. That's just
132+
how life is sometimes.)
133+
- Grab old specification even if it has `\r\n` as line endings rather than pure `\n`s
134+
- Various warning and specification fixes
135+
- Fix "no such file to load -- annotate/annotate_models (MissingSourceFile)"
136+
error (require statements in tasks now use full path to lib files)
137+
- warn about macros, to mitigate when we're included during a production
138+
run, not just a rakefile run -- possibly at the expense of too much noise
139+
- Adding rake as a runtime dependency
140+
- If the schema is already in the model file, it will be replaced into the same location.
141+
If it didn't previously exist, it'll be placed according to the "position", as before.
142+
- Allow task loading from Rakefile for gems (plugin installation already auto-detects).
143+
- Add skip_on_db_migrate option as well for people that don't want it
144+
- Fix options parsing to convert strings to proper booleans
145+
- Add support for Fabrication fabricators
146+
- Leave magic encoding comment intact
147+
- Fix issue #14 - RuntimeError: Already memoized
148+
- Count a model as 'annotated' if any of its tests/fixtures are annotated
149+
- Support FactoryGirl
150+
- Support :change migrations (Rails 3.1)
151+
- Allow models with non-standard capitalization
152+
- Widen type column so we can handle longtexts with chopping things off.
153+
- Skip trying to get list of models from commandline when running via Rake
154+
(was preventing the use of multiple rake tasks in one command if one of them was `db:migrate`).
155+
- Add ability to skip annotations for a model by adding
156+
`# -*- SkipSchemaAnnotations` anywhere in the file.
157+
- Don't show column limits for integer and boolean types.
158+
- Add sorting for columns and indexes.
159+
(Helpful for out-of-order migration execution. Use `--sort` if you want this.)
160+
- Annotate unit tests in subfolders.
161+
- Add generator to install rakefile that automatically annotates on `db:migrate`.
162+
- Correct Gemfile to clarify which environments need which gems.
163+
- Add an .rvmrc to facilitate clean development.
164+
- Refactor out ActiveRecord monkey-patch to permit extending without side-effects.
165+
- Use ObjectSpace to locate models to facilitate handling of models with
166+
non-standard capitalization.
167+
Note that this still requires that the inflector be configured to understand
168+
the special case.
169+
- Shore up test cases a bit.
170+
- Merge against many of the older branches on Github whose functionality is
171+
already reflected to reduce confusion about what is and is not implemented here.
172+
- Accept String or Symbol for :position (et al) options.
173+
- Add RDoc output formatting as an option.
174+
- Add Markdown output formatting as an option.
175+
- Add option to force annotation regeneration.
176+
- Add new configuration option for controlling where info is placed in
177+
fixtures/factories.
178+
- Fix for models without tables.
179+
- Fix gemspec generation now that Jeweler looks at Gemfile.
180+
- Fix warning: `NOTE: Gem::Specification#default_executable= is deprecated
181+
with no replacement. It will be removed on or after 2011-10-01.`
182+
- Fix handling of files with no trailing newline when putting annotations at
183+
the end of the file.
184+
- Now works on tables with no primary key.
185+
- `--format=markdown` option
186+
- `--trace` option to help debug "Unable to annotate" errors
187+
- "Table name" annotation (if table name is different from model name)
188+
- "Human name" annotation (enabling translation to non-English locales)
189+
- Fix JRuby ObjectSpace compatibility bug (https://github.com/ctran/annotate_models/pull/85)
190+
- Fix FactoryGirl compatibility bug (https://github.com/ctran/annotate_models/pull/82)
191+
192+
193+
## 2.4.2 2009-11-21
194+
- Annotates `(spec|test)/factories/<model>_factory.rb` files
195+
196+
## 2.4.1 2009-11-20
197+
198+
- Annotates thoughtbot's factory_girl factories (`test/factories/<model>_factory.rb`)
199+
- Move default annotation position back to top
200+
201+
202+
## 2.4.0 2009-12-13
203+
- Incorporated lots of patches from the Github community,
204+
including support for Blueprints fixtures
205+
- Several bug fixes
206+
207+
## 2.1 2009-10-18
208+
209+
- New options
210+
- `-R` to require additional files before loading the models
211+
- `-i` to show database indexes in annotations
212+
- `-e` to exclude annotating tests or fixtures
213+
- `-m` to include the migration version number in the annotation
214+
- `--model-dir` to annotate model files stored a different place than `app/models`
215+
216+
- Ignore unknown macros ('acts_as_whatever')
217+
218+
219+
## 2.0 2009-02-03
220+
221+
- Add annotate_models plugin fork additions
222+
- Annotates Rspec and Test Unit models
223+
- Annotates Object Daddy exemplars
224+
- Annotates geometrical columns
225+
226+
- Add AnnotateRoutes rake task
227+
- Up gem structure to newgem defaults
228+
229+
230+
## 1.0.4 2008-09-04
231+
232+
- Only update modified models since last run, thanks to sant0sk1
233+
234+
## 1.0.3 2008-05-02
235+
236+
- Add misc changes from Dustin Sallings and Henrik N
237+
- Remove trailing whitespace
238+
- More intuitive info messages
239+
- Update README file with update-to-date example
240+
241+
## 1.0.2 2008-03-22
242+
243+
- Add contributions from Michael Bumann (http://github.com/bumi)
244+
- added an option "position" to choose to put the annotation,
245+
- spec/fixtures now also get annotated
246+
- added a task to remove the annotations
247+
- these options can be specified from command line as `-d` and `-p [before|after]`
248+
249+

0 commit comments

Comments
 (0)