annotate 2.6.0 → 2.6.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +9 -9
- data/LICENSE.txt +55 -0
- data/README.rdoc +19 -20
- data/annotate.gemspec +6 -4
- data/bin/annotate +2 -1
- data/lib/annotate/version.rb +1 -1
- metadata +12 -7
checksums.yaml
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
---
|
2
2
|
!binary "U0hBMQ==":
|
3
3
|
metadata.gz: !binary |-
|
4
|
-
|
4
|
+
ZWI2ZDRiZDhkOTkwNDNmMDMxYWU2ZTY3NWEyYzMyMzVlYTc2OTFmMA==
|
5
5
|
data.tar.gz: !binary |-
|
6
|
-
|
7
|
-
|
6
|
+
OWQ0MTY4ZjZmZWFmNDU0Yzc4NDgzNmNkNjM5MmNlN2U3NjQzZWM4OQ==
|
7
|
+
SHA512:
|
8
8
|
metadata.gz: !binary |-
|
9
|
-
|
10
|
-
|
11
|
-
|
9
|
+
MDdkYmQ1ZjE0ZTQ4ZWYyNzYxMGQ3YTNlZDMxZDRmZGJiNzlkZTc0ZjgxNGFk
|
10
|
+
NDAwZjVmOGNmM2Y3OTRiNWE4ZjYwOWU4NGIwNWE4ZmI3MzI2YjZiOWJlZWQz
|
11
|
+
YTlkZWQ5NjUxOGVjM2VjMmFlMTJlZDVkZGZlMTA1Yzk0NGYwNDA=
|
12
12
|
data.tar.gz: !binary |-
|
13
|
-
|
14
|
-
|
15
|
-
|
13
|
+
ZTZkMDkzODI2MTQ1MjY3ZjgzNjFjMjUxNTcwMzVjM2JhYmQzYzJmZGFiYjE4
|
14
|
+
NjcwNDg1MDk5ZTMwMmI5YzJmNjk0ZThmYzM1ZWEyNjQ4NzdlMDM1MTJiMDRm
|
15
|
+
MjQ2ZDY0NjJkMzUxNWZkNGQ0M2FmMjY1MjM5N2EyOTc1ZmY1OGE=
|
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.
|
data/README.rdoc
CHANGED
@@ -33,7 +33,7 @@ The schema comment looks like this:
|
|
33
33
|
. . .
|
34
34
|
|
35
35
|
It also annotates geometrical columns, geom type and srid, when using
|
36
|
-
|
36
|
+
+SpatialAdapter+, +PostgisAdapter+ or +PostGISAdapter+:
|
37
37
|
|
38
38
|
# == Schema Info
|
39
39
|
#
|
@@ -43,14 +43,14 @@ It also annotates geometrical columns, geom type and srid, when using
|
|
43
43
|
# path :geometry line_string, 4326
|
44
44
|
|
45
45
|
Also, if you pass the -r option, it'll annotate routes.rb with the output of
|
46
|
-
|
46
|
+
+rake routes+.
|
47
47
|
|
48
48
|
|
49
49
|
== Install
|
50
50
|
|
51
51
|
Into Gemfile from rubygems.org:
|
52
52
|
|
53
|
-
gem 'annotate', ">=2.
|
53
|
+
gem 'annotate', ">=2.6.0"
|
54
54
|
|
55
55
|
Into Gemfile from Github:
|
56
56
|
|
@@ -70,7 +70,7 @@ Into environment gems from Github checkout:
|
|
70
70
|
|
71
71
|
== Usage
|
72
72
|
|
73
|
-
(If you used the Gemfile install, prefix the below commands with
|
73
|
+
(If you used the Gemfile install, prefix the below commands with +bundle exec+.)
|
74
74
|
|
75
75
|
=== Usage in Rails
|
76
76
|
|
@@ -105,9 +105,9 @@ To remove routes.rb annotations:
|
|
105
105
|
|
106
106
|
=== Usage Outside of Rails
|
107
107
|
|
108
|
-
Everything above applies, except that
|
109
|
-
probably need to explicitly set one or more
|
110
|
-
or more
|
108
|
+
Everything above applies, except that +--routes+ is not meaningful, and you will
|
109
|
+
probably need to explicitly set one or more +--require+ option(s), and/or one
|
110
|
+
or more +--model-dir+ options to inform annotate about the structure of your
|
111
111
|
project and help it bootstrap and load the relevant code.
|
112
112
|
|
113
113
|
|
@@ -121,7 +121,7 @@ anywhere in the file:
|
|
121
121
|
|
122
122
|
=== Configuration in Rails
|
123
123
|
|
124
|
-
To generate a configuration file (in the form of a
|
124
|
+
To generate a configuration file (in the form of a +.rake+ file), to set
|
125
125
|
default options:
|
126
126
|
|
127
127
|
rails g annotate:install
|
@@ -132,8 +132,8 @@ added (top or bottom of file), and in which artifacts.
|
|
132
132
|
== Rails Integration
|
133
133
|
|
134
134
|
By default, once you've generated a configuration file, annotate will be
|
135
|
-
executed whenever you run
|
136
|
-
If you want to disable this behavior permanently, edit the
|
135
|
+
executed whenever you run +rake db:migrate+ (but only in development mode).
|
136
|
+
If you want to disable this behavior permanently, edit the +.rake+ file and
|
137
137
|
change:
|
138
138
|
|
139
139
|
'skip_on_db_migrate' => "false",
|
@@ -142,9 +142,9 @@ To:
|
|
142
142
|
|
143
143
|
'skip_on_db_migrate' => "true",
|
144
144
|
|
145
|
-
If you want to run
|
145
|
+
If you want to run +rake db:migrate+ as a one-off without running annotate,
|
146
146
|
you can do so with a simple environment variable, instead of editing the
|
147
|
-
|
147
|
+
+.rake+ file:
|
148
148
|
|
149
149
|
skip_on_db_migrate=1 rake db:migrate
|
150
150
|
|
@@ -188,21 +188,21 @@ migrations were run).
|
|
188
188
|
|
189
189
|
If you prefer to sort alphabetically so that the results of
|
190
190
|
annotation are consistent regardless of what order migrations are executed in,
|
191
|
-
use
|
191
|
+
use +--sort+.
|
192
192
|
|
193
193
|
|
194
194
|
== Markdown
|
195
195
|
|
196
196
|
The format produced is actually MultiMarkdown, making use of the syntax
|
197
|
-
extension for tables. It's recommended you use
|
198
|
-
you want to use this format. If you're using
|
199
|
-
specify a format of markdown with
|
200
|
-
your
|
197
|
+
extension for tables. It's recommended you use +kramdown+ as your parser if
|
198
|
+
you want to use this format. If you're using +yard+ to generate documentation,
|
199
|
+
specify a format of markdown with +kramdown+ as the provider by adding this to
|
200
|
+
your +.yardopts+ file:
|
201
201
|
|
202
202
|
--markup markdown
|
203
203
|
--markup-provider kramdown
|
204
204
|
|
205
|
-
Be sure to add this to your
|
205
|
+
Be sure to add this to your +Gemfile+ as well:
|
206
206
|
|
207
207
|
gem 'kramdown', :groups => [:development], :require => false
|
208
208
|
|
@@ -214,7 +214,7 @@ will blow away the initial/final comment block in your models if it looks like
|
|
214
214
|
it was previously added by this gem.
|
215
215
|
|
216
216
|
Be sure to check the changes that this tool makes! If you are using Git,
|
217
|
-
you may simply check your project's status after running
|
217
|
+
you may simply check your project's status after running +annotate+:
|
218
218
|
|
219
219
|
$ git status
|
220
220
|
|
@@ -244,4 +244,3 @@ Released under the same license as Ruby. No Support. No Warranty.
|
|
244
244
|
== Authors
|
245
245
|
|
246
246
|
{See AUTHORS.rdoc}[link:AUTHORS.rdoc].
|
247
|
-
|
data/annotate.gemspec
CHANGED
@@ -1,23 +1,25 @@
|
|
1
1
|
# This file is auto-generated!
|
2
2
|
# DO NOT EDIT THIS FILE DIRECTLY!
|
3
3
|
# Instead, edit the Rakefile and run 'rake gems:gemspec'.# -*- encoding: utf-8 -*-
|
4
|
+
# stub: annotate 2.6.1 ruby lib
|
4
5
|
|
5
6
|
Gem::Specification.new do |s|
|
6
7
|
s.name = "annotate"
|
7
|
-
s.version = "2.6.
|
8
|
+
s.version = "2.6.1"
|
8
9
|
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
9
11
|
s.authors = ["Cuong Tran", "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]
|
10
|
-
s.date = "2013-
|
12
|
+
s.date = "2013-12-21"
|
11
13
|
s.description = "Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema."
|
12
14
|
s.email = ["alex@stinky.com", "ctran@pragmaquest.com", "x@nofxx.com", "turadg@aleahmad.net", "jon@cloudability.com"]
|
13
15
|
s.executables = ["annotate"]
|
14
16
|
s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "TODO.rdoc"]
|
15
|
-
s.files = ["AUTHORS.rdoc", "CHANGELOG.rdoc", "README.rdoc", "TODO.rdoc", "annotate.gemspec", "bin/annotate", "lib/annotate.rb", "lib/annotate/active_record_patch.rb", "lib/annotate/annotate_models.rb", "lib/annotate/annotate_routes.rb", "lib/annotate/tasks.rb", "lib/annotate/version.rb", "lib/generators/annotate/USAGE", "lib/generators/annotate/install_generator.rb", "lib/generators/annotate/templates/auto_annotate_models.rake", "lib/tasks/annotate_models.rake", "lib/tasks/annotate_routes.rake", "tasks/migrate.rake"]
|
17
|
+
s.files = ["AUTHORS.rdoc", "CHANGELOG.rdoc", "LICENSE.txt", "README.rdoc", "TODO.rdoc", "annotate.gemspec", "bin/annotate", "lib/annotate.rb", "lib/annotate/active_record_patch.rb", "lib/annotate/annotate_models.rb", "lib/annotate/annotate_routes.rb", "lib/annotate/tasks.rb", "lib/annotate/version.rb", "lib/generators/annotate/USAGE", "lib/generators/annotate/install_generator.rb", "lib/generators/annotate/templates/auto_annotate_models.rake", "lib/tasks/annotate_models.rake", "lib/tasks/annotate_routes.rake", "tasks/migrate.rake"]
|
16
18
|
s.homepage = "http://github.com/ctran/annotate_models"
|
17
19
|
s.licenses = ["Ruby"]
|
18
20
|
s.require_paths = ["lib"]
|
19
21
|
s.rubyforge_project = "annotate"
|
20
|
-
s.rubygems_version = "2.
|
22
|
+
s.rubygems_version = "2.1.11"
|
21
23
|
s.summary = "Annotates Rails Models, routes, fixtures, and others based on the database schema."
|
22
24
|
|
23
25
|
if s.respond_to? :specification_version then
|
data/bin/annotate
CHANGED
@@ -119,7 +119,8 @@ OptionParser.new do |opts|
|
|
119
119
|
end
|
120
120
|
end
|
121
121
|
|
122
|
-
opts.on('-e', '--exclude [
|
122
|
+
opts.on('-e', '--exclude [DIRS]', ['tests','fixtures','factories'], "Do not annotate fixtures, test files, and/or factories") do |exclusions|
|
123
|
+
exclusions ||= %w(tests fixtures factories)
|
123
124
|
exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = "yes" }
|
124
125
|
end
|
125
126
|
|
data/lib/annotate/version.rb
CHANGED
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: 2.6.
|
4
|
+
version: 2.6.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Cuong Tran
|
@@ -12,7 +12,7 @@ authors:
|
|
12
12
|
autorequire:
|
13
13
|
bindir: bin
|
14
14
|
cert_chain: []
|
15
|
-
date: 2013-
|
15
|
+
date: 2013-12-21 00:00:00.000000000 Z
|
16
16
|
dependencies:
|
17
17
|
- !ruby/object:Gem::Dependency
|
18
18
|
name: rake
|
@@ -20,28 +20,32 @@ dependencies:
|
|
20
20
|
requirements:
|
21
21
|
- - ! '>='
|
22
22
|
- !ruby/object:Gem::Version
|
23
|
-
version:
|
23
|
+
version: !binary |-
|
24
|
+
MC44Ljc=
|
24
25
|
type: :runtime
|
25
26
|
prerelease: false
|
26
27
|
version_requirements: !ruby/object:Gem::Requirement
|
27
28
|
requirements:
|
28
29
|
- - ! '>='
|
29
30
|
- !ruby/object:Gem::Version
|
30
|
-
version:
|
31
|
+
version: !binary |-
|
32
|
+
MC44Ljc=
|
31
33
|
- !ruby/object:Gem::Dependency
|
32
34
|
name: activerecord
|
33
35
|
requirement: !ruby/object:Gem::Requirement
|
34
36
|
requirements:
|
35
37
|
- - ! '>='
|
36
38
|
- !ruby/object:Gem::Version
|
37
|
-
version:
|
39
|
+
version: !binary |-
|
40
|
+
Mi4zLjA=
|
38
41
|
type: :runtime
|
39
42
|
prerelease: false
|
40
43
|
version_requirements: !ruby/object:Gem::Requirement
|
41
44
|
requirements:
|
42
45
|
- - ! '>='
|
43
46
|
- !ruby/object:Gem::Version
|
44
|
-
version:
|
47
|
+
version: !binary |-
|
48
|
+
Mi4zLjA=
|
45
49
|
description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
|
46
50
|
on the database schema.
|
47
51
|
email:
|
@@ -60,6 +64,7 @@ extra_rdoc_files:
|
|
60
64
|
files:
|
61
65
|
- AUTHORS.rdoc
|
62
66
|
- CHANGELOG.rdoc
|
67
|
+
- LICENSE.txt
|
63
68
|
- README.rdoc
|
64
69
|
- TODO.rdoc
|
65
70
|
- annotate.gemspec
|
@@ -96,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
96
101
|
version: '0'
|
97
102
|
requirements: []
|
98
103
|
rubyforge_project: annotate
|
99
|
-
rubygems_version: 2.
|
104
|
+
rubygems_version: 2.1.11
|
100
105
|
signing_key:
|
101
106
|
specification_version: 4
|
102
107
|
summary: Annotates Rails Models, routes, fixtures, and others based on the database
|