annotate 3.0.2 → 3.0.3
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 +4 -4
- data/CHANGELOG.rdoc +8 -1
- data/README.rdoc +8 -7
- data/RELEASE.rdoc +17 -0
- data/annotate.gemspec +4 -24
- data/lib/annotate/version.rb +1 -1
- data/lib/generators/annotate/templates/auto_annotate_models.rake +1 -1
- metadata +7 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 559a54cd715c8d97ed5eea63d85822d2a4f8ceef35c34256fac6243a6bd7c01c
|
4
|
+
data.tar.gz: 9378a8a21e2eba4bccf5f7b77eedf894d4b569121da31f05670aafee6dbd09fc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fefbdc4b01c33e20c403186b54b5a550515e110ffe33848a8f112ec402d2bee40c7946205a401e5b974ebda361216ec22faef62b8eaec98d4fc12827620bfbc4
|
7
|
+
data.tar.gz: 0fd4cb8eb60753311f0b33b845fefa14534c3791cb7047b04e493210b159cf8a091c0d9bc87c9580f7fa7c71ed2df738556d2f4701c0e54cc1f660e70150b552
|
data/CHANGELOG.rdoc
CHANGED
@@ -1,3 +1,10 @@
|
|
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
|
+
* Defaults annotate models to true (#671)
|
6
|
+
* Bump loofah from 2.3.0 to 2.3.1 in /spec/integration/rails_4.2.0 (#681)
|
7
|
+
|
1
8
|
== 3.0.2
|
2
9
|
* Fixes `LoadError` due to gemspec not referencing `parser.rb`, issue #657 (#660)
|
3
10
|
* Changes `--additional_file_patterns` to use dashes `--additional-file-patterns` for consistency (#649)
|
@@ -8,7 +15,7 @@
|
|
8
15
|
|
9
16
|
== 3.0.0
|
10
17
|
* Added `--models` CLI option fixing issue #563 (#647)
|
11
|
-
* Added `--additional_file_patterns` option for additional file patterns (#633) #636) #637)
|
18
|
+
* Added `--additional_file_patterns` option for additional file patterns (#633) (#636) (#637)
|
12
19
|
* Refactored CLI parser (#646)
|
13
20
|
* Fixed BigDecimal.new deprecation warning (#634)
|
14
21
|
* Fixed annotations for columns with long data types (#622)
|
data/README.rdoc
CHANGED
@@ -3,6 +3,7 @@
|
|
3
3
|
{<img src="https://badge.fury.io/rb/annotate.svg" alt="Gem Version" />}[http://badge.fury.io/rb/annotate]
|
4
4
|
{<img src="https://img.shields.io/gem/dt/annotate.svg?style=flat" />}[https://rubygems.org/gems/annotate]
|
5
5
|
{<img src="https://travis-ci.org/ctran/annotate_models.svg?branch=develop" />}[https://travis-ci.org/ctran/annotate_models]
|
6
|
+
{<img src="https://github.com/ctran/annotate_models/workflows/CI/badge.svg" />}[https://github.com/ctran/annotate_models/actions?workflow=CI]
|
6
7
|
{<img src="https://coveralls.io/repos/ctran/annotate_models/badge.svg?branch=develop" />}[https://coveralls.io/r/ctran/annotate_models?branch=develop]
|
7
8
|
{<img src="https://codeclimate.com/github/ctran/annotate_models/badges/gpa.svg" />}[https://codeclimate.com/github/ctran/annotate_models]
|
8
9
|
{<img src="http://inch-ci.org/github/ctran/annotate_models.svg?branch=develop" alt="Inline docs" />}[http://inch-ci.org/github/ctran/annotate_models]
|
@@ -163,7 +164,7 @@ you can do so with a simple environment variable, instead of editing the
|
|
163
164
|
== Options
|
164
165
|
|
165
166
|
Usage: annotate [options] [model_file]*
|
166
|
-
--
|
167
|
+
--additional_file_patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
|
167
168
|
-d, --delete Remove annotations from all model files or the routes.rb file
|
168
169
|
-p [before|top|after|bottom], Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)
|
169
170
|
--position
|
@@ -216,18 +217,18 @@ you can do so with a simple environment variable, instead of editing the
|
|
216
217
|
--ignore-unknown-models don't display warnings for bad model files
|
217
218
|
--with-comment include database comments in model annotations
|
218
219
|
|
219
|
-
=== Option: +
|
220
|
+
=== Option: +additional_file_patterns+
|
220
221
|
|
221
|
-
CLI: +--
|
222
|
-
Ruby: +:
|
222
|
+
CLI: +--additional_file_patterns+<br>
|
223
|
+
Ruby: +:additional_file_patterns+
|
223
224
|
|
224
225
|
Provide additional paths for the gem to annotate. These paths can include globs.
|
225
226
|
It is recommended to use absolute paths. Here are some examples:
|
226
227
|
|
227
228
|
|
228
|
-
- <code>/app/lib/decorates/%MODEL_NAME
|
229
|
-
- <code>/app/lib/forms/%PLURALIZED_MODEL_NAME
|
230
|
-
- <code>/app/lib/forms/%TABLE_NAME
|
229
|
+
- <code>/app/lib/decorates/%MODEL_NAME%/*.rb</code>
|
230
|
+
- <code>/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb</code>
|
231
|
+
- <code>/app/lib/forms/%TABLE_NAME%/*.rb</code>
|
231
232
|
|
232
233
|
The appropriate model will be inferred using the <code>%*%</code> syntax, annotating any matching files.
|
233
234
|
It works with existing filename resolutions (options for which can be found in the +resolve_filename+ method of
|
data/RELEASE.rdoc
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
== Prerequisite
|
2
|
+
|
3
|
+
- Install "git-flow" (brew install git-flow)
|
4
|
+
- Install "bump" gem (gem install bump)
|
5
|
+
|
6
|
+
== Perform a release
|
7
|
+
|
8
|
+
- git flow release start <release>
|
9
|
+
- Update the CHANGELOG.rdoc file
|
10
|
+
- bump current
|
11
|
+
- bump patch
|
12
|
+
- rm -rf dist
|
13
|
+
- rake spec
|
14
|
+
- rake gem
|
15
|
+
- git flow release finish <release>
|
16
|
+
|
17
|
+
- rake gem:publish
|
data/annotate.gemspec
CHANGED
@@ -14,29 +14,7 @@ Gem::Specification.new do |s|
|
|
14
14
|
s.email = ['alex@stinky.com', 'cuong.tran@gmail.com', 'x@nofxx.com', 'turadg@aleahmad.net', 'jon@cloudability.com']
|
15
15
|
s.executables = ['annotate']
|
16
16
|
s.extra_rdoc_files = ['README.rdoc', 'CHANGELOG.rdoc', 'TODO.rdoc']
|
17
|
-
s.files =
|
18
|
-
'AUTHORS.rdoc',
|
19
|
-
'CHANGELOG.rdoc',
|
20
|
-
'LICENSE.txt',
|
21
|
-
'README.rdoc',
|
22
|
-
'TODO.rdoc',
|
23
|
-
'annotate.gemspec',
|
24
|
-
'bin/annotate',
|
25
|
-
'lib/annotate.rb',
|
26
|
-
'lib/annotate/active_record_patch.rb',
|
27
|
-
'lib/annotate/annotate_models.rb',
|
28
|
-
'lib/annotate/annotate_routes.rb',
|
29
|
-
'lib/annotate/constants.rb',
|
30
|
-
'lib/annotate/parser.rb',
|
31
|
-
'lib/annotate/tasks.rb',
|
32
|
-
'lib/annotate/version.rb',
|
33
|
-
'lib/generators/annotate/USAGE',
|
34
|
-
'lib/generators/annotate/install_generator.rb',
|
35
|
-
'lib/generators/annotate/templates/auto_annotate_models.rake',
|
36
|
-
'lib/tasks/annotate_models.rake',
|
37
|
-
'lib/tasks/annotate_routes.rake',
|
38
|
-
'lib/tasks/annotate_models_migrate.rake'
|
39
|
-
]
|
17
|
+
s.files = `git ls-files -z LICENSE.txt *.rdoc *.gemspec bin lib`.split("\x0")
|
40
18
|
s.homepage = 'http://github.com/ctran/annotate_models'
|
41
19
|
s.licenses = ['Ruby']
|
42
20
|
s.require_paths = ['lib']
|
@@ -44,6 +22,8 @@ Gem::Specification.new do |s|
|
|
44
22
|
s.summary = 'Annotates Rails Models, routes, fixtures, and others based on the database schema.'
|
45
23
|
|
46
24
|
s.specification_version = 4 if s.respond_to? :specification_version
|
47
|
-
s.add_runtime_dependency(%q<rake>,
|
25
|
+
s.add_runtime_dependency(%q<rake>, '>= 10.4', '< 14.0')
|
48
26
|
s.add_runtime_dependency(%q<activerecord>, ['>= 3.2', '< 7.0'])
|
27
|
+
|
28
|
+
s.metadata = { "github_repo" => "ssh://github.com/ctran/annotate_models" }
|
49
29
|
end
|
data/lib/annotate/version.rb
CHANGED
@@ -9,7 +9,7 @@ if Rails.env.development?
|
|
9
9
|
Annotate.set_defaults(
|
10
10
|
'additional_file_patterns' => [],
|
11
11
|
'routes' => 'false',
|
12
|
-
'models' => '
|
12
|
+
'models' => 'true',
|
13
13
|
'position_in_routes' => 'before',
|
14
14
|
'position_in_class' => 'before',
|
15
15
|
'position_in_test' => 'before',
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: annotate
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Alex Chaffee
|
@@ -12,7 +12,7 @@ authors:
|
|
12
12
|
autorequire:
|
13
13
|
bindir: bin
|
14
14
|
cert_chain: []
|
15
|
-
date: 2019-09
|
15
|
+
date: 2019-11-09 00:00:00.000000000 Z
|
16
16
|
dependencies:
|
17
17
|
- !ruby/object:Gem::Dependency
|
18
18
|
name: rake
|
@@ -23,7 +23,7 @@ dependencies:
|
|
23
23
|
version: '10.4'
|
24
24
|
- - "<"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: '
|
26
|
+
version: '14.0'
|
27
27
|
type: :runtime
|
28
28
|
prerelease: false
|
29
29
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -33,7 +33,7 @@ dependencies:
|
|
33
33
|
version: '10.4'
|
34
34
|
- - "<"
|
35
35
|
- !ruby/object:Gem::Version
|
36
|
-
version: '
|
36
|
+
version: '14.0'
|
37
37
|
- !ruby/object:Gem::Dependency
|
38
38
|
name: activerecord
|
39
39
|
requirement: !ruby/object:Gem::Requirement
|
@@ -74,6 +74,7 @@ files:
|
|
74
74
|
- CHANGELOG.rdoc
|
75
75
|
- LICENSE.txt
|
76
76
|
- README.rdoc
|
77
|
+
- RELEASE.rdoc
|
77
78
|
- TODO.rdoc
|
78
79
|
- annotate.gemspec
|
79
80
|
- bin/annotate
|
@@ -94,7 +95,8 @@ files:
|
|
94
95
|
homepage: http://github.com/ctran/annotate_models
|
95
96
|
licenses:
|
96
97
|
- Ruby
|
97
|
-
metadata:
|
98
|
+
metadata:
|
99
|
+
github_repo: ssh://github.com/ctran/annotate_models
|
98
100
|
post_install_message:
|
99
101
|
rdoc_options: []
|
100
102
|
require_paths:
|