Skip to content

Commit eb633bc

Browse files
author
Cuong Tran
committed
Merge branch 'release/2.6.1'
2 parents 8c4f399 + 3a83d9d commit eb633bc

File tree

5 files changed

+82
-25
lines changed

5 files changed

+82
-25
lines changed

LICENSE.txt

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.

README.rdoc

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The schema comment looks like this:
3333
. . .
3434

3535
It also annotates geometrical columns, geom type and srid, when using
36-
`SpatialAdapter`, `PostgisAdapter` or `PostGISAdapter`:
36+
+SpatialAdapter+, +PostgisAdapter+ or +PostGISAdapter+:
3737

3838
# == Schema Info
3939
#
@@ -43,7 +43,7 @@ It also annotates geometrical columns, geom type and srid, when using
4343
# path :geometry line_string, 4326
4444

4545
Also, if you pass the -r option, it'll annotate routes.rb with the output of
46-
`rake routes`.
46+
+rake routes+.
4747

4848

4949
== Install
@@ -70,7 +70,7 @@ Into environment gems from Github checkout:
7070

7171
== Usage
7272

73-
(If you used the Gemfile install, prefix the below commands with `bundle exec`.)
73+
(If you used the Gemfile install, prefix the below commands with +bundle exec+.)
7474

7575
=== Usage in Rails
7676

@@ -105,9 +105,9 @@ To remove routes.rb annotations:
105105

106106
=== Usage Outside of Rails
107107

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
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
111111
project and help it bootstrap and load the relevant code.
112112

113113

@@ -121,7 +121,7 @@ anywhere in the file:
121121

122122
=== Configuration in Rails
123123

124-
To generate a configuration file (in the form of a `.rake` file), to set
124+
To generate a configuration file (in the form of a +.rake+ file), to set
125125
default options:
126126

127127
rails g annotate:install
@@ -132,8 +132,8 @@ added (top or bottom of file), and in which artifacts.
132132
== Rails Integration
133133

134134
By default, once you've generated a configuration file, annotate will be
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
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
137137
change:
138138

139139
'skip_on_db_migrate' => "false",
@@ -142,9 +142,9 @@ To:
142142

143143
'skip_on_db_migrate' => "true",
144144

145-
If you want to run `rake db:migrate` as a one-off without running annotate,
145+
If you want to run +rake db:migrate+ as a one-off without running annotate,
146146
you can do so with a simple environment variable, instead of editing the
147-
`.rake` file:
147+
+.rake+ file:
148148

149149
skip_on_db_migrate=1 rake db:migrate
150150

@@ -188,21 +188,21 @@ migrations were run).
188188

189189
If you prefer to sort alphabetically so that the results of
190190
annotation are consistent regardless of what order migrations are executed in,
191-
use --sort.
191+
use +--sort+.
192192

193193

194194
== Markdown
195195

196196
The format produced is actually MultiMarkdown, making use of the syntax
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:
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:
201201

202202
--markup markdown
203203
--markup-provider kramdown
204204

205-
Be sure to add this to your `Gemfile` as well:
205+
Be sure to add this to your +Gemfile+ as well:
206206

207207
gem 'kramdown', :groups => [:development], :require => false
208208

@@ -214,7 +214,7 @@ will blow away the initial/final comment block in your models if it looks like
214214
it was previously added by this gem.
215215

216216
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 `annotate`:
217+
you may simply check your project's status after running +annotate+:
218218

219219
$ git status
220220

@@ -244,4 +244,3 @@ Released under the same license as Ruby. No Support. No Warranty.
244244
== Authors
245245

246246
{See AUTHORS.rdoc}[link:AUTHORS.rdoc].
247-

annotate.gemspec

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# This file is auto-generated!
22
# DO NOT EDIT THIS FILE DIRECTLY!
33
# Instead, edit the Rakefile and run 'rake gems:gemspec'.# -*- encoding: utf-8 -*-
4+
# stub: annotate 2.6.1 ruby lib
45

56
Gem::Specification.new do |s|
67
s.name = "annotate"
7-
s.version = "2.6.0"
8+
s.version = "2.6.1"
89

10+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
911
s.authors = ["Cuong Tran", "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]
10-
s.date = "2013-11-29"
12+
s.date = "2013-12-21"
1113
s.description = "Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema."
1214
1315
s.executables = ["annotate"]
1416
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"]
1618
s.homepage = "http://github.com/ctran/annotate_models"
1719
s.licenses = ["Ruby"]
1820
s.require_paths = ["lib"]
1921
s.rubyforge_project = "annotate"
20-
s.rubygems_version = "2.0.6"
22+
s.rubygems_version = "2.1.11"
2123
s.summary = "Annotates Rails Models, routes, fixtures, and others based on the database schema."
2224

2325
if s.respond_to? :specification_version then

bin/annotate

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ OptionParser.new do |opts|
119119
end
120120
end
121121

122-
opts.on('-e', '--exclude [tests,fixtures,factories]', ['tests','fixtures','factories'], "Do not annotate fixtures, test files, and/or factories") do |exclusions|
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)
123124
exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = "yes" }
124125
end
125126

lib/annotate/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module Annotate
22
def self.version
3-
'2.6.0'
3+
'2.6.1'
44
end
55
end

0 commit comments

Comments
 (0)