annotated 0.0.1 → 0.0.2
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/README.md +14 -15
- data/annotated.gemspec +1 -1
- data/lib/annotated/version.rb +1 -1
- data/lib/annotated.rb +0 -2
- data/lib/generators/{annotate → annotated}/install_generator.rb +1 -1
- metadata +6 -6
- /data/bin/{annotated → annotate} +0 -0
- /data/lib/generators/{annotate → annotated}/USAGE +0 -0
- /data/lib/generators/{annotate → annotated}/templates/auto_annotate_models.rake +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ea4ef76844ac894dd5f2e1c7b8da271b11895a9a12c52463c0e3c8dce030b52f
|
|
4
|
+
data.tar.gz: 8b05151069ef5c88b6d3d39d08ab2010eebfc4a58075572ba3b6468b9d014088
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6f428b49d763c6958f54ad635e90b667844899845121741a9609e7f47efc752d0ea2eaa3cf283402762e5413eae215cc2d88477a621dadcb846f0553620f2e13
|
|
7
|
+
data.tar.gz: 25c0ce76f86c2580e58c13221161de979bbbd73dc50fbe89dfd01fa76f58514d5b40c181bb1c34688f12b8fb14e37f82eacf6dd9126f699588b8ca1346865c5d
|
data/README.md
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
|
-
## Annotated (fork of Annotate aka AnnotateModels)
|
|
1
|
+
## Annotated (drop-in fork of Annotate aka AnnotateModels)
|
|
2
|
+
|
|
3
|
+
> This is a fork of the [annotate](https://github.com/ctran/annotate_models) gem, created to provide ongoing maintenance and updates while maintaining drop-in compatibility. This fork was created in response to the original gem's maintenance status (see [discussion](https://github.com/ctran/annotate_models/issues/1028)) and serves as an alternative to [annotaterb](https://github.com/drwl/annotaterb) which introduces breaking changes.
|
|
4
|
+
>
|
|
5
|
+
> Unlike annotaterb, this gem aims to be a direct drop-in replacement for the original annotate gem, allowing users to migrate without any minimal to their existing configuration or workflow.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
[](http://badge.fury.io/rb/annotated)
|
|
9
|
+
[](https://rubygems.org/gems/annotated)
|
|
10
|
+
[](https://github.com/thedumbtechguy/annotated/actions?workflow=CI)
|
|
2
11
|
|
|
3
|
-
[](http://badge.fury.io/rb/annotate)
|
|
4
|
-
[](https://rubygems.org/gems/annotate)
|
|
5
|
-
[](https://github.com/ctran/annotate_models/actions?workflow=CI)
|
|
6
|
-
[](https://coveralls.io/r/ctran/annotate_models?branch=develop)
|
|
7
|
-
[](https://codeclimate.com/github/ctran/annotate_models)
|
|
8
12
|
|
|
9
13
|
Add a comment summarizing the current schema to the top or bottom of each of your...
|
|
10
14
|
|
|
@@ -82,7 +86,7 @@ Into Gemfile from rubygems.org:
|
|
|
82
86
|
|
|
83
87
|
```ruby
|
|
84
88
|
group :development do
|
|
85
|
-
gem '
|
|
89
|
+
gem 'annotated'
|
|
86
90
|
end
|
|
87
91
|
```
|
|
88
92
|
|
|
@@ -90,20 +94,15 @@ Into Gemfile from Github:
|
|
|
90
94
|
|
|
91
95
|
```ruby
|
|
92
96
|
group :development do
|
|
93
|
-
gem '
|
|
97
|
+
gem 'annotated', git: 'https://github.com/thedumbtechguy/annotated.git'
|
|
94
98
|
end
|
|
95
99
|
```
|
|
96
100
|
|
|
97
101
|
Into environment gems from rubygems.org:
|
|
98
102
|
|
|
99
|
-
gem install
|
|
103
|
+
gem install annotated
|
|
100
104
|
|
|
101
|
-
Into environment gems from Github checkout:
|
|
102
105
|
|
|
103
|
-
git clone https://github.com/ctran/annotate_models.git annotate_models
|
|
104
|
-
cd annotate_models
|
|
105
|
-
rake gem
|
|
106
|
-
gem install dist/annotate-*.gem
|
|
107
106
|
|
|
108
107
|
## Usage
|
|
109
108
|
|
|
@@ -137,7 +136,7 @@ To remove routes.rb annotations:
|
|
|
137
136
|
annotate --routes --delete
|
|
138
137
|
|
|
139
138
|
To automatically annotate every time you run `db:migrate`,
|
|
140
|
-
either run `rails g
|
|
139
|
+
either run `rails g annotated:install`
|
|
141
140
|
or add `Annotated.load_tasks` to your `Rakefile`.
|
|
142
141
|
|
|
143
142
|
See the [configuration in Rails](#configuration-in-rails) section for more info.
|
data/annotated.gemspec
CHANGED
|
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
|
|
|
38
38
|
|
|
39
39
|
spec.files = Dir.glob(%w[LICENSE.txt *.md *.gemspec bin/* lib/**/*])
|
|
40
40
|
spec.bindir = "bin"
|
|
41
|
-
spec.executables = ["
|
|
41
|
+
spec.executables = ["annotate"]
|
|
42
42
|
spec.require_paths = ["lib"]
|
|
43
43
|
|
|
44
44
|
spec.add_dependency "activerecord", ">= 3.2"
|
data/lib/annotated/version.rb
CHANGED
data/lib/annotated.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: annotated
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Stefan Froelich
|
|
@@ -39,7 +39,7 @@ email:
|
|
|
39
39
|
- turadg@aleahmad.net
|
|
40
40
|
- jon@cloudability.com
|
|
41
41
|
executables:
|
|
42
|
-
-
|
|
42
|
+
- annotate
|
|
43
43
|
extensions: []
|
|
44
44
|
extra_rdoc_files: []
|
|
45
45
|
files:
|
|
@@ -49,7 +49,7 @@ files:
|
|
|
49
49
|
- README.md
|
|
50
50
|
- RELEASE.md
|
|
51
51
|
- annotated.gemspec
|
|
52
|
-
- bin/
|
|
52
|
+
- bin/annotate
|
|
53
53
|
- lib/annotated.rb
|
|
54
54
|
- lib/annotated/active_record_patch.rb
|
|
55
55
|
- lib/annotated/annotate_models.rb
|
|
@@ -62,9 +62,9 @@ files:
|
|
|
62
62
|
- lib/annotated/parser.rb
|
|
63
63
|
- lib/annotated/tasks.rb
|
|
64
64
|
- lib/annotated/version.rb
|
|
65
|
-
- lib/generators/
|
|
66
|
-
- lib/generators/
|
|
67
|
-
- lib/generators/
|
|
65
|
+
- lib/generators/annotated/USAGE
|
|
66
|
+
- lib/generators/annotated/install_generator.rb
|
|
67
|
+
- lib/generators/annotated/templates/auto_annotate_models.rake
|
|
68
68
|
- lib/tasks/annotate_models.rake
|
|
69
69
|
- lib/tasks/annotate_models_migrate.rake
|
|
70
70
|
- lib/tasks/annotate_routes.rake
|
/data/bin/{annotated → annotate}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|