updoc 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +37 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +39 -0
- data/Rakefile +10 -0
- data/bin/console +11 -0
- data/bin/setup +7 -0
- data/lib/updoc/config.rb +19 -0
- data/lib/updoc/consumer.rb +29 -0
- data/lib/updoc/consumers.rb +27 -0
- data/lib/updoc/depends_on.rb +21 -0
- data/lib/updoc/producer.rb +20 -0
- data/lib/updoc/report/rack_report.rb +49 -0
- data/lib/updoc/report/rails_report.rb +72 -0
- data/lib/updoc/report.rb +59 -0
- data/lib/updoc/tasks/rack.rb +10 -0
- data/lib/updoc/tasks/rails.rb +10 -0
- data/lib/updoc/tasks.rb +15 -0
- data/lib/updoc/version.rb +3 -0
- data/lib/updoc.rb +18 -0
- data/updoc.gemspec +25 -0
- metadata +122 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: bd5bdfa244bbf64163d2fdf15114d8bc524fe8ae
|
4
|
+
data.tar.gz: 5b51e02332bc07ae8859e33bf0a649784bb2f615
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1da54a287289ccd50b5baef66d23e61d494d620fd15bb4f1f756fd45323761d87a7b8a6a131cf8d887bf319548f273ce314ada92b87b98944bece2fbd17026ee
|
7
|
+
data.tar.gz: 751134c4686fb4170ad98bcafdcb0cd75a79eafd6de45ca562dcb123e2dc36d70db8f981e1ffa948832dfc850660351cd7fc563a2fde642dfb7e5df0643deaf0
|
data/.gitignore
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
Gemfile.lock
|
4
|
+
/.config
|
5
|
+
/coverage/
|
6
|
+
/InstalledFiles
|
7
|
+
/pkg/
|
8
|
+
/spec/reports/
|
9
|
+
/spec/examples.txt
|
10
|
+
/test/tmp/
|
11
|
+
/test/version_tmp/
|
12
|
+
/tmp/
|
13
|
+
|
14
|
+
## Specific to RubyMotion:
|
15
|
+
.dat*
|
16
|
+
.repl_history
|
17
|
+
build/
|
18
|
+
|
19
|
+
## Documentation cache and generated files:
|
20
|
+
/.yardoc/
|
21
|
+
/_yardoc/
|
22
|
+
/doc/
|
23
|
+
/rdoc/
|
24
|
+
|
25
|
+
## Environment normalization:
|
26
|
+
/.bundle/
|
27
|
+
/vendor/bundle
|
28
|
+
/lib/bundler/man/
|
29
|
+
|
30
|
+
# for a library or gem, you might want to ignore these files since the code is
|
31
|
+
# intended to run in multiple environments; otherwise, check them in:
|
32
|
+
# Gemfile.lock
|
33
|
+
# .ruby-version
|
34
|
+
# .ruby-gemset
|
35
|
+
|
36
|
+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
|
37
|
+
.rvmrc
|
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
# Updoc
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/updoc`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'updoc'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install updoc
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
1. Fork it ( https://github.com/[my-github-username]/updoc/fork )
|
36
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
37
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
38
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
39
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "updoc"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
require "pry"
|
11
|
+
Pry.start
|
data/bin/setup
ADDED
data/lib/updoc/config.rb
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
module Updoc
|
2
|
+
module Config
|
3
|
+
|
4
|
+
Storage = Struct.new(:feature_name, :config)
|
5
|
+
|
6
|
+
def self.included(base)
|
7
|
+
base.extend(ClassMethods)
|
8
|
+
end
|
9
|
+
|
10
|
+
module ClassMethods
|
11
|
+
def updoc
|
12
|
+
@updoc ||= Storage.new(
|
13
|
+
self.to_s.underscore,
|
14
|
+
OpenStruct.new
|
15
|
+
)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
require 'updoc/consumers'
|
2
|
+
require 'updoc/config'
|
3
|
+
|
4
|
+
module Updoc
|
5
|
+
module Consumer
|
6
|
+
|
7
|
+
ConsumerConfig = Struct.new(:consumer_name, :services)
|
8
|
+
|
9
|
+
def self.included(base)
|
10
|
+
base.include(Updoc::Config) unless base < Updoc::Config
|
11
|
+
base.updoc.extend(UpdocClassMethods)
|
12
|
+
base.updoc.config[:consumer] = ConsumerConfig.new(nil, [])
|
13
|
+
end
|
14
|
+
|
15
|
+
module UpdocClassMethods
|
16
|
+
|
17
|
+
def register_consumer(name: , service_type:, definition_uri:)
|
18
|
+
config.consumer.consumer_name = name if name
|
19
|
+
Updoc::Consumers.register_consumer(name, service_type, definition_uri)
|
20
|
+
end
|
21
|
+
|
22
|
+
def register_consumer_service(*service_urns)
|
23
|
+
fail 'Must register_consumer before registering a service' if config.consumer.consumer_name.nil?
|
24
|
+
Updoc::Consumers.register_consumer_services(config.consumer.consumer_name, service_urns)
|
25
|
+
config.consumer.services += service_urns
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
require 'updoc/consumer'
|
2
|
+
|
3
|
+
module Updoc
|
4
|
+
class Consumers
|
5
|
+
|
6
|
+
Definition = Struct.new(:name, :service_type, :definition_uri, :services)
|
7
|
+
|
8
|
+
class << self
|
9
|
+
extend Forwardable
|
10
|
+
|
11
|
+
def_delegators :consumers, *Hash.new.public_methods(false)
|
12
|
+
|
13
|
+
def consumers
|
14
|
+
@consumers ||= {}
|
15
|
+
end
|
16
|
+
|
17
|
+
def register_consumer(name, service_type, definition_uri)
|
18
|
+
consumers[name] ||= Definition.new(name, service_type, definition_uri, [])
|
19
|
+
end
|
20
|
+
|
21
|
+
def register_consumer_services(name, service_urns)
|
22
|
+
fail "Must register consumer #{name} before adding services #{service_urns}" unless consumers[name]
|
23
|
+
consumers[name].services.concat(service_urns).uniq!
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
require 'updoc/config'
|
2
|
+
require 'updoc/consumers'
|
3
|
+
|
4
|
+
module Updoc
|
5
|
+
module DependsOn
|
6
|
+
DependsOnConfig = Struct.new(:feature, :consumers)
|
7
|
+
|
8
|
+
def self.included(base)
|
9
|
+
base.include(Updoc::Config) unless base < Updoc::Config
|
10
|
+
base.updoc.extend(UpdocClassMethods)
|
11
|
+
base.updoc.config[:depends_on] = DependsOnConfig.new(base.to_s.underscore, {})
|
12
|
+
end
|
13
|
+
|
14
|
+
module UpdocClassMethods
|
15
|
+
def depends_on(name, *service_urn)
|
16
|
+
config.depends_on.consumers[name] ||= []
|
17
|
+
config.depends_on.consumers[name].concat(service_urn).uniq!
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
require 'updoc/config'
|
2
|
+
|
3
|
+
module Updoc
|
4
|
+
module Producer
|
5
|
+
ProducerConfig = Struct.new(:feature_name, :service_type)
|
6
|
+
|
7
|
+
def self.included(base)
|
8
|
+
base.include(Updoc::Config) unless base < Updoc::Config
|
9
|
+
base.updoc.extend(UpdocClassMethods)
|
10
|
+
base.updoc.config[:producer] = ProducerConfig.new(base.updoc.feature_name)
|
11
|
+
end
|
12
|
+
|
13
|
+
module UpdocClassMethods
|
14
|
+
def produce_as(name: nil, service_type: nil)
|
15
|
+
config.producer.feature_name = name if name
|
16
|
+
config.producer.service_type = service_type if service_type
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
require 'rack'
|
2
|
+
|
3
|
+
module Updoc
|
4
|
+
module Report
|
5
|
+
class RackReport
|
6
|
+
include Updoc::Report
|
7
|
+
|
8
|
+
def self.report!
|
9
|
+
new.report!
|
10
|
+
end
|
11
|
+
|
12
|
+
def initialize
|
13
|
+
@rack_app = ::Rack::Server.new(config: 'config.ru').app # loads all the deps
|
14
|
+
end
|
15
|
+
|
16
|
+
def report!
|
17
|
+
fail 'Updoc.application_name must be defined' unless Updoc.application_name
|
18
|
+
|
19
|
+
report = base_report.merge(
|
20
|
+
consumes: map_updoc_consumers,
|
21
|
+
produces: map_producers_from_rack
|
22
|
+
)
|
23
|
+
|
24
|
+
write_updoc_report(File.expand_path('updoc.yml'), report)
|
25
|
+
end
|
26
|
+
|
27
|
+
def map_producers_from_rack
|
28
|
+
producers = {}
|
29
|
+
middleware = rack_app
|
30
|
+
while middleware
|
31
|
+
if Object.const_defined?('Grape::API') && middleware.class < Grape::API
|
32
|
+
prefix = middleware.class.prefix
|
33
|
+
producers.merge!(
|
34
|
+
map_grape_endpoints([GrapeApp.new(middleware.class, prefix)])
|
35
|
+
)
|
36
|
+
end
|
37
|
+
|
38
|
+
middleware = middleware.instance_variable_get('@app')
|
39
|
+
end
|
40
|
+
|
41
|
+
producers
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
attr_reader :rack_app
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
module Updoc
|
2
|
+
module Report
|
3
|
+
class Rails
|
4
|
+
include Updoc::Report
|
5
|
+
|
6
|
+
def self.report!(rails_app = ::Rails.application)
|
7
|
+
new(rails_app).report!
|
8
|
+
end
|
9
|
+
|
10
|
+
def initialize(rails_app)
|
11
|
+
@rails_app = rails_app
|
12
|
+
rails_app.eager_load!
|
13
|
+
end
|
14
|
+
|
15
|
+
def report!
|
16
|
+
report = base_report.merge(
|
17
|
+
consumes: map_updoc_consumers,
|
18
|
+
produces: map_producers_from_rails
|
19
|
+
)
|
20
|
+
|
21
|
+
report[:name] ||= rails_app.class.parent_name
|
22
|
+
|
23
|
+
write_updoc_report(File.expand_path(File.join(rails_app.root, 'updoc.yml')), report)
|
24
|
+
end
|
25
|
+
|
26
|
+
def map_producers_from_rails
|
27
|
+
if Object.const_defined?('Grape::API')
|
28
|
+
map_grape_endpoints(
|
29
|
+
rails_app.routes.routes.select do |r|
|
30
|
+
r.app.class <= Class && r.app < Grape::API
|
31
|
+
end.map { |rails_route| GrapeApp.new(rails_route.app, rails_route.path.spec.to_s) }
|
32
|
+
)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
private
|
37
|
+
|
38
|
+
attr_reader :rails_app
|
39
|
+
end
|
40
|
+
|
41
|
+
def base_report
|
42
|
+
{
|
43
|
+
name: Updoc.application_name,
|
44
|
+
updoc_version: Updoc::VERSION
|
45
|
+
}.tap do |report|
|
46
|
+
if Updoc.git?
|
47
|
+
git_uri = `git config --get remote.origin.url`.strip
|
48
|
+
updoc_file = `git ls-files -z updoc.yml`.split("\x0").first
|
49
|
+
report[:definition_uri] = "git:#{git_uri}/#{updoc_file}"
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
def map_updoc_consumers
|
55
|
+
dependents = ObjectSpace.each_object(::Class).select { |x| x < Updoc::DependsOn }
|
56
|
+
dependents.each_with_object({}) do |dependent, memo|
|
57
|
+
consumers = {}
|
58
|
+
|
59
|
+
depends_on = dependent.updoc.config.depends_on
|
60
|
+
depends_on.consumers.each do |name, services|
|
61
|
+
consumers[name] = {
|
62
|
+
service_type: Updoc::Consumers[name].service_type,
|
63
|
+
definition_uri: Updoc::Consumers[name].definition_uri,
|
64
|
+
services: services
|
65
|
+
}
|
66
|
+
end
|
67
|
+
|
68
|
+
memo[dependent.updoc.feature_name] = consumers
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
data/lib/updoc/report.rb
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
require 'updoc'
|
2
|
+
|
3
|
+
module Updoc
|
4
|
+
module Report
|
5
|
+
SORT = [:name, :definition_uri, :consumes, :produces, :updoc_version]
|
6
|
+
|
7
|
+
GrapeApp = Struct.new(:app, :path_prefix)
|
8
|
+
|
9
|
+
def map_grape_endpoints(grape_apps)
|
10
|
+
updoc_supported_routes = grape_apps.flat_map do |grape_app|
|
11
|
+
app_feature = grape_app.app.updoc.feature_name if grape_app.app < Updoc::Config
|
12
|
+
|
13
|
+
grape_app.app.endpoints.flat_map do |endpoint|
|
14
|
+
endpoint.routes.map do |r|
|
15
|
+
detail = {
|
16
|
+
description: r.route_description,
|
17
|
+
method: r.route_method.downcase,
|
18
|
+
path: r.route_path,
|
19
|
+
feature: app_feature
|
20
|
+
}
|
21
|
+
|
22
|
+
detail[:path] = File.join(*[grape_app.path_prefix.to_s, detail[:path]].compact) if grape_app.path_prefix
|
23
|
+
|
24
|
+
if endpoint.options[:app]
|
25
|
+
detail[:feature] = endpoint.options[:app].updoc.feature_name if endpoint.options[:app] < Updoc::Producer
|
26
|
+
detail[:content_types] = endpoint.options[:app].content_types
|
27
|
+
end
|
28
|
+
|
29
|
+
detail if detail[:feature]
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end.compact.sort_by { |r| [r[:feature], r[:method], r[:path]] }
|
33
|
+
|
34
|
+
updoc_supported_routes.group_by { |r| r[:feature] }.each_with_object({}) do |(feature, routes), memo|
|
35
|
+
memo[feature] = {
|
36
|
+
service_type: 'REST',
|
37
|
+
services: routes.each_with_object({}) do |route, memo|
|
38
|
+
memo["rest:#{route[:method]}:#{route[:path]}"] = route.slice(:description, :content_types)
|
39
|
+
end
|
40
|
+
}
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
def write_updoc_report(file_path, report)
|
45
|
+
report = (SORT | report.keys).each_with_object({}) do |key, hash|
|
46
|
+
hash[key] = report[key]
|
47
|
+
end
|
48
|
+
|
49
|
+
report.delete_if { |_, v| v.nil? || v.empty? }
|
50
|
+
|
51
|
+
IO.write(file_path, report.to_yaml)
|
52
|
+
|
53
|
+
file_path
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
require 'updoc/report/rack_report'
|
59
|
+
require 'updoc/report/rails_report'
|
data/lib/updoc/tasks.rb
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'updoc'
|
2
|
+
|
3
|
+
module Updoc
|
4
|
+
module Tasks
|
5
|
+
def self.load_rails_tasks
|
6
|
+
gem_spec = Gem::Specification.find_by_name('updoc')
|
7
|
+
require File.join(gem_spec.gem_dir, 'lib/updoc/tasks/rails')
|
8
|
+
end
|
9
|
+
|
10
|
+
def self.load_rack_tasks
|
11
|
+
gem_spec = Gem::Specification.find_by_name('updoc')
|
12
|
+
require File.join(gem_spec.gem_dir, 'lib/updoc/tasks/rack')
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
data/lib/updoc.rb
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
require "updoc/version"
|
2
|
+
require 'updoc/config'
|
3
|
+
require 'updoc/consumer'
|
4
|
+
require 'updoc/consumers'
|
5
|
+
require 'updoc/depends_on'
|
6
|
+
require 'updoc/producer'
|
7
|
+
require 'updoc/report'
|
8
|
+
|
9
|
+
module Updoc
|
10
|
+
|
11
|
+
class << self
|
12
|
+
attr_accessor :application_name
|
13
|
+
|
14
|
+
def git?
|
15
|
+
!`git --version`.nil?
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
data/updoc.gemspec
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'updoc/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "updoc"
|
8
|
+
spec.version = Updoc::VERSION
|
9
|
+
spec.authors = ["Michael Guymon"]
|
10
|
+
spec.email = ["michaelguymon@swipely.com"]
|
11
|
+
|
12
|
+
spec.summary = 'Generates a report of application producers and consumers'
|
13
|
+
spec.description = 'Generates a report of application producers and consumers'
|
14
|
+
spec.homepage = 'https://github.com/swipely/updoc'
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
17
|
+
spec.bindir = "exe"
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
22
|
+
spec.add_development_dependency "pry"
|
23
|
+
spec.add_development_dependency "grape"
|
24
|
+
spec.add_development_dependency "rspec"
|
25
|
+
end
|
metadata
ADDED
@@ -0,0 +1,122 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: updoc
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Michael Guymon
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-04-20 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
15
|
+
requirements:
|
16
|
+
- - "~>"
|
17
|
+
- !ruby/object:Gem::Version
|
18
|
+
version: '10.0'
|
19
|
+
name: rake
|
20
|
+
prerelease: false
|
21
|
+
type: :development
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '10.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
29
|
+
requirements:
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '0'
|
33
|
+
name: pry
|
34
|
+
prerelease: false
|
35
|
+
type: :development
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - ">="
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '0'
|
47
|
+
name: grape
|
48
|
+
prerelease: false
|
49
|
+
type: :development
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - ">="
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '0'
|
61
|
+
name: rspec
|
62
|
+
prerelease: false
|
63
|
+
type: :development
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: Generates a report of application producers and consumers
|
70
|
+
email:
|
71
|
+
- michaelguymon@swipely.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".travis.yml"
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- bin/console
|
84
|
+
- bin/setup
|
85
|
+
- lib/updoc.rb
|
86
|
+
- lib/updoc/config.rb
|
87
|
+
- lib/updoc/consumer.rb
|
88
|
+
- lib/updoc/consumers.rb
|
89
|
+
- lib/updoc/depends_on.rb
|
90
|
+
- lib/updoc/producer.rb
|
91
|
+
- lib/updoc/report.rb
|
92
|
+
- lib/updoc/report/rack_report.rb
|
93
|
+
- lib/updoc/report/rails_report.rb
|
94
|
+
- lib/updoc/tasks.rb
|
95
|
+
- lib/updoc/tasks/rack.rb
|
96
|
+
- lib/updoc/tasks/rails.rb
|
97
|
+
- lib/updoc/version.rb
|
98
|
+
- updoc.gemspec
|
99
|
+
homepage: https://github.com/swipely/updoc
|
100
|
+
licenses: []
|
101
|
+
metadata: {}
|
102
|
+
post_install_message:
|
103
|
+
rdoc_options: []
|
104
|
+
require_paths:
|
105
|
+
- lib
|
106
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
112
|
+
requirements:
|
113
|
+
- - ">="
|
114
|
+
- !ruby/object:Gem::Version
|
115
|
+
version: '0'
|
116
|
+
requirements: []
|
117
|
+
rubyforge_project:
|
118
|
+
rubygems_version: 2.4.8
|
119
|
+
signing_key:
|
120
|
+
specification_version: 4
|
121
|
+
summary: Generates a report of application producers and consumers
|
122
|
+
test_files: []
|