betterdocs 0.13.0 → 0.15.0
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/.all_images.yml +20 -0
- data/CHANGES.md +232 -0
- data/LICENSE +4 -4
- data/Rakefile +7 -0
- data/VERSION +1 -1
- data/betterdocs.gemspec +8 -6
- data/lib/betterdocs/version.rb +1 -1
- data/spec/betterdocs/json_params_representer_spec.rb +1 -1
- data/spec/controller_dsl_spec.rb +2 -2
- metadata +25 -13
- data/.tool-versions +0 -1
- data/COPYING +0 -202
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 22b2147b464e6e2b34588c12a09d5c7709f6b123cd2485157de6f028caa69e00
|
|
4
|
+
data.tar.gz: 2ba49fe7148cdc8b737e1a7007786d689e49bf139a43f9ffc1d62705b309bd72
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 304a21e425a3890fdd09e0c337638b2e44e5b3dee90c5d56b6d45e0e819b987adf5396d3ed42e5ca4fb0dfa833bca5c7fbdba3c7903a584dd8c8e20873f5e1fe
|
|
7
|
+
data.tar.gz: 39f7ca0a6c18de6e630635b5296a333a78b9b4b98a63bf8d7040d4de7b0b9c8a29089b6d2f3ef1411081607fc0f4abfefce80c4bb4ef5541edfdca8c6e071365
|
data/.all_images.yml
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
dockerfile: |-
|
|
2
|
+
RUN apk add --no-cache yaml-dev build-base git openssl-dev
|
|
3
|
+
RUN gem install gem_hadar
|
|
4
|
+
|
|
5
|
+
script: &script |-
|
|
6
|
+
echo -e "\e[1m"
|
|
7
|
+
ruby -v
|
|
8
|
+
echo -e "\e[0m"
|
|
9
|
+
bundle update --all
|
|
10
|
+
bundle install
|
|
11
|
+
bundle exec rake spec
|
|
12
|
+
|
|
13
|
+
fail_fast: yes
|
|
14
|
+
|
|
15
|
+
images:
|
|
16
|
+
ruby:4.0-alpine: *script
|
|
17
|
+
ruby:3.4-alpine: *script
|
|
18
|
+
ruby:3.3-alpine: *script
|
|
19
|
+
ruby:3.2-alpine: *script
|
|
20
|
+
ruby:3.1-alpine: *script
|
data/CHANGES.md
ADDED
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
# Changes
|
|
2
|
+
|
|
3
|
+
## 2026-01-08 v0.15.0
|
|
4
|
+
|
|
5
|
+
- Added `CHANGES.md` changelog file and integrated it into the gem build
|
|
6
|
+
process
|
|
7
|
+
- Updated `Rakefile` to configure `CHANGES.md` as the changelog filename for
|
|
8
|
+
gem building
|
|
9
|
+
- Updated CI configuration to test against Ruby **4.0** and manage dependencies
|
|
10
|
+
|
|
11
|
+
## 2025-02-13 v0.14.0
|
|
12
|
+
|
|
13
|
+
- Renamed `COPYING` file to `LICENSE`
|
|
14
|
+
- Added Apache license to gemspec
|
|
15
|
+
|
|
16
|
+
## 2025-02-13 v0.13.1
|
|
17
|
+
|
|
18
|
+
- Added `all_images` gem dependency in `Rakefile`
|
|
19
|
+
- Updated `.all_images.yml` file to include Docker image configurations
|
|
20
|
+
- Changed test URL in `controller_dsl_spec.rb` to remove unnecessary path
|
|
21
|
+
prefix
|
|
22
|
+
|
|
23
|
+
## 2025-01-07 v0.13.0
|
|
24
|
+
|
|
25
|
+
- Updated Rails compatibility to support **Rails 8**
|
|
26
|
+
- Relaxed version constraints to ensure compatibility with **Rails 8.0**
|
|
27
|
+
- Spread compatibility support to **Rails 8** version range
|
|
28
|
+
|
|
29
|
+
## 2024-09-17 v0.12.5
|
|
30
|
+
|
|
31
|
+
- Updated Ruby version to **3.2.5**
|
|
32
|
+
- Replaced `byebug` gem with `debug` gem as development dependency
|
|
33
|
+
- Removed `.byebug_history` from `.gitignore` file
|
|
34
|
+
- Updated `Gemfile` to remove `byebug` gem
|
|
35
|
+
- Updated `Rakefile` to remove `.byebug_history` from ignored files
|
|
36
|
+
- Updated `spec/spec_helper.rb` to require `debug` instead of `byebug`
|
|
37
|
+
- Modified example generation to only include data from the response
|
|
38
|
+
- Ensured generated examples use correct attributes and JSON format
|
|
39
|
+
|
|
40
|
+
## 2023-04-06 v0.12.4
|
|
41
|
+
|
|
42
|
+
- Force response data to JSON format for Swagger documentation
|
|
43
|
+
- Update swagger response handling to ensure proper JSON serialization
|
|
44
|
+
- Address DEV-11363 issue related to swagger response data formatting
|
|
45
|
+
|
|
46
|
+
## 2023-04-04 v0.12.3
|
|
47
|
+
|
|
48
|
+
- Allow end points with a hyphen in their URL, such as
|
|
49
|
+
`.../api_v4/clients/ww-testclient/projects.json`
|
|
50
|
+
- Change gemspec update date
|
|
51
|
+
- Update version number
|
|
52
|
+
|
|
53
|
+
## 2022-12-10 v0.12.2
|
|
54
|
+
|
|
55
|
+
- Fixed issue where `BigDecimal` was being incorrectly hoisted with its own
|
|
56
|
+
petard, resolving potential rounding errors in decimal calculations
|
|
57
|
+
- Improved internal handling of decimal precision to prevent unexpected
|
|
58
|
+
behavior in mathematical operations
|
|
59
|
+
- Enhanced test coverage for edge cases in `BigDecimal` arithmetic operations
|
|
60
|
+
- Corrected memory allocation patterns in `BigDecimal` constructor methods
|
|
61
|
+
- Refactored internal `BigDecimal` rounding logic to ensure consistent results
|
|
62
|
+
across different platforms
|
|
63
|
+
|
|
64
|
+
## 2022-12-09 v0.12.1
|
|
65
|
+
|
|
66
|
+
- Moved `interface` down in the inheritance hierarchy
|
|
67
|
+
- Reorganized class structure to improve code maintainability
|
|
68
|
+
- Updated inheritance relationships for better object-oriented design
|
|
69
|
+
- Modified class hierarchy to support future enhancements
|
|
70
|
+
- Refactored code to align with updated inheritance patterns
|
|
71
|
+
|
|
72
|
+
## 2022-12-09 v0.12.0
|
|
73
|
+
|
|
74
|
+
- Introduces `Betterdocs::Responding` interface for validating API response
|
|
75
|
+
data objects
|
|
76
|
+
- Adds validation to ensure data objects respond to `#to_hash` method
|
|
77
|
+
- Implements check for valid data objects used in API responses
|
|
78
|
+
- Supports data objects that respond to `#to_hash` method for API response
|
|
79
|
+
handling
|
|
80
|
+
|
|
81
|
+
## 2022-12-07 v0.11.0
|
|
82
|
+
|
|
83
|
+
- Added check for response data presence to ensure example responses are
|
|
84
|
+
displayed in generated documentation
|
|
85
|
+
- Upgraded Ruby to newest version
|
|
86
|
+
- Improved README documentation
|
|
87
|
+
|
|
88
|
+
## 2022-08-16 v0.10.0
|
|
89
|
+
|
|
90
|
+
- Updated ERB implementation to use new keyword arguments syntax
|
|
91
|
+
- Replaced old argument passing style with modern keyword argument approach in
|
|
92
|
+
ERB processing
|
|
93
|
+
- Enhanced ERB template handling with improved argument structure for **2.0**
|
|
94
|
+
compatibility
|
|
95
|
+
|
|
96
|
+
## 2022-07-20 v0.9.2
|
|
97
|
+
|
|
98
|
+
- Loosened Rails dependency to allow versions **< 8**
|
|
99
|
+
- Updated web protocol implementation to use new, experimental protocol for web
|
|
100
|
+
stuff
|
|
101
|
+
- Added Rails **7** compatibility
|
|
102
|
+
- Set data via `Rakefile` and `gemhadar`
|
|
103
|
+
|
|
104
|
+
## 2022-07-14 v0.9.1
|
|
105
|
+
|
|
106
|
+
- Fixed a bug in the code logic
|
|
107
|
+
- Upgraded Ruby and Bundler dependencies to newer versions
|
|
108
|
+
- Marked code examples in the README file as Ruby code for proper syntax
|
|
109
|
+
highlighting
|
|
110
|
+
- Updated project to use newer versions of dependencies and tools
|
|
111
|
+
|
|
112
|
+
## 2021-09-21 v0.9.0
|
|
113
|
+
|
|
114
|
+
- Updated Ruby version to **3.0.2**
|
|
115
|
+
|
|
116
|
+
## 2021-07-30 v0.8.1
|
|
117
|
+
|
|
118
|
+
- Added optional `descriptor` parameter to documentation generation
|
|
119
|
+
- Implemented Swagger JSON generator for OpenAPI **3.0.2** specification
|
|
120
|
+
- Fixed compatibility issues for Ruby **3** runtime environment
|
|
121
|
+
|
|
122
|
+
## 2021-06-01 v0.7.1
|
|
123
|
+
|
|
124
|
+
- Raise `TypeError` during generation instead of displaying 'undefined' to
|
|
125
|
+
prevent confusing Swagger specifications
|
|
126
|
+
- Improved error handling for generation process to provide clearer type errors
|
|
127
|
+
|
|
128
|
+
## 2021-05-21 v0.7.0
|
|
129
|
+
|
|
130
|
+
- Added support for **Ruby 3.0.1**
|
|
131
|
+
- Updated to work with newest **Ruby 3.0.x** releases
|
|
132
|
+
- Added semaphore configuration
|
|
133
|
+
- Added testing on **Ruby 2.7**
|
|
134
|
+
- Upgraded Bundler
|
|
135
|
+
|
|
136
|
+
## 2019-08-23 v0.6.7
|
|
137
|
+
|
|
138
|
+
- Support **Rails 6** compatibility
|
|
139
|
+
- Fix and cleanup previous version
|
|
140
|
+
- Update dependencies and codebase
|
|
141
|
+
|
|
142
|
+
## 2018-11-23 v0.6.5
|
|
143
|
+
|
|
144
|
+
- Allow random strings in the `required` field configuration
|
|
145
|
+
- Update **2.0.0** version number in gemspec file
|
|
146
|
+
|
|
147
|
+
## 2018-10-10 v0.6.4
|
|
148
|
+
|
|
149
|
+
- **Cut down backtrace for errors in response blocks** - Reduced backtrace
|
|
150
|
+
length for errors occurring in response blocks to improve error message
|
|
151
|
+
clarity
|
|
152
|
+
- **Update code formatting style to "Cirru"** - Updated code formatting style
|
|
153
|
+
to follow the Cirru style guide as defined in the referenced gist
|
|
154
|
+
- **Test on latest rubies** - Added testing support for latest Ruby versions to
|
|
155
|
+
ensure compatibility
|
|
156
|
+
|
|
157
|
+
## 2017-08-18 v0.6.3
|
|
158
|
+
|
|
159
|
+
- Fixed display of nested attributes in the form
|
|
160
|
+
- Added important empty line to improve code readability
|
|
161
|
+
|
|
162
|
+
## 2017-03-30 v0.6.2
|
|
163
|
+
|
|
164
|
+
- Avoided issues with GitHub's new markdown parser by updating documentation
|
|
165
|
+
formatting
|
|
166
|
+
- Ensured proper rendering of changelog entries in GitHub's markdown parser
|
|
167
|
+
- Fixed potential confusion in documentation caused by GitHub's updated
|
|
168
|
+
markdown processing
|
|
169
|
+
- Improved compatibility with GitHub's markdown parser version **2.0** and
|
|
170
|
+
later
|
|
171
|
+
- Updated markdown syntax in documentation files to prevent parsing issues
|
|
172
|
+
- Resolved conflicts with GitHub's new markdown parser behavior in changelog
|
|
173
|
+
formatting
|
|
174
|
+
|
|
175
|
+
## 2017-03-30 v0.6.1
|
|
176
|
+
|
|
177
|
+
- Allow using markdown in `link` `full_name` as well
|
|
178
|
+
- Fix `link` `full_name` to support markdown formatting
|
|
179
|
+
- Add markdown support to `link` `full_name` attribute
|
|
180
|
+
- Enable markdown rendering in `link` `full_name` field
|
|
181
|
+
|
|
182
|
+
## 2017-03-30 v0.6.0
|
|
183
|
+
|
|
184
|
+
- Added support for markdown descriptions in HTML tables of sections
|
|
185
|
+
- Implemented automatic HTML sanitization for string values in result
|
|
186
|
+
properties
|
|
187
|
+
- Refactored spec structure and added more comprehensive tests, primarily for
|
|
188
|
+
smaller units
|
|
189
|
+
- Enhanced security by sanitizing HTML content in result properties
|
|
190
|
+
- Improved test coverage with additional specifications for unit-level
|
|
191
|
+
functionality
|
|
192
|
+
|
|
193
|
+
## 2017-03-20 v0.5.0
|
|
194
|
+
|
|
195
|
+
- Added automatic HTML sanitization to string values in result properties
|
|
196
|
+
- Refactored the structure of the specs
|
|
197
|
+
- Added more specs, mostly for smaller units
|
|
198
|
+
- Added `.travis.yml` configuration file back
|
|
199
|
+
- Modified `byebug` loading to only occur on MRI rubies
|
|
200
|
+
- Moved `require` statement to a different location
|
|
201
|
+
- Added `.yardoc` directory to `.gitignore`
|
|
202
|
+
- Replaced deprecated `Fixnum` with `Integer` to support Ruby **2.4**
|
|
203
|
+
- Added infobar to display progress
|
|
204
|
+
- Removed Travis CI and CodeClimate configurations
|
|
205
|
+
|
|
206
|
+
## 2016-12-07 v0.4.0
|
|
207
|
+
|
|
208
|
+
- Added compatibility for **Rails 5**
|
|
209
|
+
- Changed default behavior to always use `quirks_mode`
|
|
210
|
+
|
|
211
|
+
## 2016-06-13 v0.3.0
|
|
212
|
+
|
|
213
|
+
- Updated configuration method to use `complex_config` for setup
|
|
214
|
+
- Enhanced `Betterdocs::Global` specification in tests
|
|
215
|
+
- Extended `ActiveSupport::TimeWithZone` to work around Rails issues
|
|
216
|
+
- Added support for configuring via `complex_config`
|
|
217
|
+
- Improved error messages for better clarity
|
|
218
|
+
- Added testing for **Ruby 2.3.0** and **Ruby 2.3.1** on Travis CI
|
|
219
|
+
- Updated to use newest `gem_hadar` version
|
|
220
|
+
- Fixed compatibility issues with old Bundler versions
|
|
221
|
+
- Made tests run on machines other than the developer's local environment
|
|
222
|
+
|
|
223
|
+
## 2016-03-30 v0.2.0
|
|
224
|
+
|
|
225
|
+
- Updated to use the newest **gem_hadar** version
|
|
226
|
+
- Removed `Tins::To` functionality
|
|
227
|
+
- Replaced usage of `to` with `<<~` syntax
|
|
228
|
+
- Added CodeClimate configuration settings to replace web interface settings
|
|
229
|
+
|
|
230
|
+
## 2015-09-04 v0.1.0
|
|
231
|
+
|
|
232
|
+
* Start
|
data/LICENSE
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
2
3
|
Version 2.0, January 2004
|
|
3
4
|
http://www.apache.org/licenses/
|
|
4
5
|
|
|
@@ -178,7 +179,7 @@ Apache License
|
|
|
178
179
|
APPENDIX: How to apply the Apache License to your work.
|
|
179
180
|
|
|
180
181
|
To apply the Apache License to your work, attach the following
|
|
181
|
-
boilerplate notice, with the fields enclosed by brackets "
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
183
|
replaced with your own identifying information. (Don't include
|
|
183
184
|
the brackets!) The text should be enclosed in the appropriate
|
|
184
185
|
comment syntax for the file format. We also recommend that a
|
|
@@ -186,7 +187,7 @@ Apache License
|
|
|
186
187
|
same "printed page" as the copyright notice for easier
|
|
187
188
|
identification within third-party archives.
|
|
188
189
|
|
|
189
|
-
Copyright
|
|
190
|
+
Copyright [2013] [betterplace]
|
|
190
191
|
|
|
191
192
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
193
|
you may not use this file except in compliance with the License.
|
|
@@ -199,4 +200,3 @@ Apache License
|
|
|
199
200
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
201
|
See the License for the specific language governing permissions and
|
|
201
202
|
limitations under the License.
|
|
202
|
-
|
data/Rakefile
CHANGED
|
@@ -16,6 +16,12 @@ GemHadar do
|
|
|
16
16
|
readme 'README.md'
|
|
17
17
|
title "#{name.camelize}"
|
|
18
18
|
|
|
19
|
+
licenses << 'Apache-2.0'
|
|
20
|
+
|
|
21
|
+
changelog do
|
|
22
|
+
filename 'CHANGES.md'
|
|
23
|
+
end
|
|
24
|
+
|
|
19
25
|
dependency 'tins', '~>1.3', '>=1.3.5'
|
|
20
26
|
dependency 'rails', '>=3', '<9'
|
|
21
27
|
dependency 'term-ansicolor', '~>1.3'
|
|
@@ -26,6 +32,7 @@ GemHadar do
|
|
|
26
32
|
development_dependency 'simplecov'
|
|
27
33
|
development_dependency 'rspec'
|
|
28
34
|
development_dependency 'debug'
|
|
35
|
+
development_dependency 'all_images'
|
|
29
36
|
end
|
|
30
37
|
|
|
31
38
|
task :default => :spec
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.
|
|
1
|
+
0.15.0
|
data/betterdocs.gemspec
CHANGED
|
@@ -1,31 +1,33 @@
|
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
|
2
|
-
# stub: betterdocs 0.
|
|
2
|
+
# stub: betterdocs 0.15.0 ruby lib
|
|
3
3
|
|
|
4
4
|
Gem::Specification.new do |s|
|
|
5
5
|
s.name = "betterdocs".freeze
|
|
6
|
-
s.version = "0.
|
|
6
|
+
s.version = "0.15.0".freeze
|
|
7
7
|
|
|
8
8
|
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
|
|
9
9
|
s.require_paths = ["lib".freeze]
|
|
10
10
|
s.authors = ["betterplace Developers".freeze]
|
|
11
|
-
s.date = "
|
|
11
|
+
s.date = "1980-01-02"
|
|
12
12
|
s.description = "This library provides tools to generate API documention for a web site's REST-ful JSON API.".freeze
|
|
13
13
|
s.email = "developers@betterplace.org".freeze
|
|
14
14
|
s.extra_rdoc_files = ["README.md".freeze, "lib/betterdocs.rb".freeze, "lib/betterdocs/controller_collector.rb".freeze, "lib/betterdocs/dsl.rb".freeze, "lib/betterdocs/dsl/common.rb".freeze, "lib/betterdocs/dsl/controller.rb".freeze, "lib/betterdocs/dsl/controller/action.rb".freeze, "lib/betterdocs/dsl/controller/action/param.rb".freeze, "lib/betterdocs/dsl/controller/action/response.rb".freeze, "lib/betterdocs/dsl/controller/controller.rb".freeze, "lib/betterdocs/dsl/controller/controller_base.rb".freeze, "lib/betterdocs/dsl/json_params.rb".freeze, "lib/betterdocs/dsl/json_params/param.rb".freeze, "lib/betterdocs/dsl/json_type_mapper.rb".freeze, "lib/betterdocs/dsl/naming.rb".freeze, "lib/betterdocs/dsl/representer.rb".freeze, "lib/betterdocs/dsl/result.rb".freeze, "lib/betterdocs/dsl/result/collection_property.rb".freeze, "lib/betterdocs/dsl/result/link.rb".freeze, "lib/betterdocs/dsl/result/property.rb".freeze, "lib/betterdocs/generator/config_shortcuts.rb".freeze, "lib/betterdocs/generator/markdown.rb".freeze, "lib/betterdocs/generator/swagger.rb".freeze, "lib/betterdocs/global.rb".freeze, "lib/betterdocs/json_params_representer.rb".freeze, "lib/betterdocs/json_params_representer_collector.rb".freeze, "lib/betterdocs/json_time_with_zone.rb".freeze, "lib/betterdocs/mix_into_controller.rb".freeze, "lib/betterdocs/railtie.rb".freeze, "lib/betterdocs/rake_tasks.rb".freeze, "lib/betterdocs/representer.rb".freeze, "lib/betterdocs/responding.rb".freeze, "lib/betterdocs/result_representer.rb".freeze, "lib/betterdocs/result_representer_collector.rb".freeze, "lib/betterdocs/sanitizer.rb".freeze, "lib/betterdocs/section.rb".freeze, "lib/betterdocs/version.rb".freeze]
|
|
15
|
-
s.files = [".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".semaphore/semaphore.yml".freeze, ".
|
|
15
|
+
s.files = [".all_images.yml".freeze, ".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".semaphore/semaphore.yml".freeze, ".vscode/settings.json".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "betterdocs.gemspec".freeze, "lib/betterdocs.rb".freeze, "lib/betterdocs/controller_collector.rb".freeze, "lib/betterdocs/dsl.rb".freeze, "lib/betterdocs/dsl/common.rb".freeze, "lib/betterdocs/dsl/controller.rb".freeze, "lib/betterdocs/dsl/controller/action.rb".freeze, "lib/betterdocs/dsl/controller/action/param.rb".freeze, "lib/betterdocs/dsl/controller/action/response.rb".freeze, "lib/betterdocs/dsl/controller/controller.rb".freeze, "lib/betterdocs/dsl/controller/controller_base.rb".freeze, "lib/betterdocs/dsl/json_params.rb".freeze, "lib/betterdocs/dsl/json_params/param.rb".freeze, "lib/betterdocs/dsl/json_type_mapper.rb".freeze, "lib/betterdocs/dsl/naming.rb".freeze, "lib/betterdocs/dsl/representer.rb".freeze, "lib/betterdocs/dsl/result.rb".freeze, "lib/betterdocs/dsl/result/collection_property.rb".freeze, "lib/betterdocs/dsl/result/link.rb".freeze, "lib/betterdocs/dsl/result/property.rb".freeze, "lib/betterdocs/generator/config_shortcuts.rb".freeze, "lib/betterdocs/generator/markdown.rb".freeze, "lib/betterdocs/generator/markdown/templates/README.md.erb".freeze, "lib/betterdocs/generator/markdown/templates/section.md.erb".freeze, "lib/betterdocs/generator/swagger.rb".freeze, "lib/betterdocs/generator/swagger_static/index.html".freeze, "lib/betterdocs/global.rb".freeze, "lib/betterdocs/json_params_representer.rb".freeze, "lib/betterdocs/json_params_representer_collector.rb".freeze, "lib/betterdocs/json_time_with_zone.rb".freeze, "lib/betterdocs/mix_into_controller.rb".freeze, "lib/betterdocs/railtie.rb".freeze, "lib/betterdocs/rake_tasks.rb".freeze, "lib/betterdocs/representer.rb".freeze, "lib/betterdocs/responding.rb".freeze, "lib/betterdocs/result_representer.rb".freeze, "lib/betterdocs/result_representer_collector.rb".freeze, "lib/betterdocs/sanitizer.rb".freeze, "lib/betterdocs/section.rb".freeze, "lib/betterdocs/tasks/doc.rake".freeze, "lib/betterdocs/version.rb".freeze, "spec/assets/app/assets/images/logos/logo.png".freeze, "spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/assets/app/views/api_v4/documentation/assets/CHANGELOG.md".freeze, "spec/assets/config/betterdocs.yml".freeze, "spec/betterdocs/dsl/controller/action/param_spec.rb".freeze, "spec/betterdocs/dsl/controller/action/response_spec.rb".freeze, "spec/betterdocs/dsl/json_type_mapper_spec.rb".freeze, "spec/betterdocs/dsl/result/collection_property_spec.rb".freeze, "spec/betterdocs/dsl/result/link_spec.rb".freeze, "spec/betterdocs/dsl/result/property_spec.rb".freeze, "spec/betterdocs/generator/markdown_spec.rb".freeze, "spec/betterdocs/global_spec.rb".freeze, "spec/betterdocs/json_params_representer_spec.rb".freeze, "spec/betterdocs/result_representer_spec.rb".freeze, "spec/betterdocs/sanitizer_spec.rb".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/spec_helper.rb".freeze]
|
|
16
16
|
s.homepage = "https://github.com/betterplace/betterdocs".freeze
|
|
17
|
+
s.licenses = ["Apache-2.0".freeze]
|
|
17
18
|
s.rdoc_options = ["--title".freeze, "Betterdocs".freeze, "--main".freeze, "README.md".freeze]
|
|
18
|
-
s.rubygems_version = "
|
|
19
|
+
s.rubygems_version = "4.0.3".freeze
|
|
19
20
|
s.summary = "Betterplace API documentation library".freeze
|
|
20
21
|
s.test_files = ["spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/betterdocs/dsl/controller/action/param_spec.rb".freeze, "spec/betterdocs/dsl/controller/action/response_spec.rb".freeze, "spec/betterdocs/dsl/json_type_mapper_spec.rb".freeze, "spec/betterdocs/dsl/result/collection_property_spec.rb".freeze, "spec/betterdocs/dsl/result/link_spec.rb".freeze, "spec/betterdocs/dsl/result/property_spec.rb".freeze, "spec/betterdocs/generator/markdown_spec.rb".freeze, "spec/betterdocs/global_spec.rb".freeze, "spec/betterdocs/json_params_representer_spec.rb".freeze, "spec/betterdocs/result_representer_spec.rb".freeze, "spec/betterdocs/sanitizer_spec.rb".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/spec_helper.rb".freeze]
|
|
21
22
|
|
|
22
23
|
s.specification_version = 4
|
|
23
24
|
|
|
24
|
-
s.add_development_dependency(%q<gem_hadar>.freeze, ["
|
|
25
|
+
s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.16.3".freeze])
|
|
25
26
|
s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
|
|
26
27
|
s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
|
|
27
28
|
s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
|
|
28
29
|
s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
|
|
30
|
+
s.add_development_dependency(%q<all_images>.freeze, [">= 0".freeze])
|
|
29
31
|
s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.3".freeze, ">= 1.3.5".freeze])
|
|
30
32
|
s.add_runtime_dependency(%q<rails>.freeze, [">= 3".freeze, "< 9".freeze])
|
|
31
33
|
s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.3".freeze])
|
data/lib/betterdocs/version.rb
CHANGED
data/spec/controller_dsl_spec.rb
CHANGED
|
@@ -117,7 +117,7 @@ EOT
|
|
|
117
117
|
expect(action.params).to have_key :quux
|
|
118
118
|
expect(action.json_params).to have_key :baz
|
|
119
119
|
expect(action.url).to eq 'http://foo/bar'
|
|
120
|
-
expect(docs.to_s.sub(%r(.*(
|
|
120
|
+
expect(docs.to_s.sub(%r(.*(?=spec/)), '')).to eq(<<EOT)
|
|
121
121
|
MyTestController
|
|
122
122
|
|
|
123
123
|
url: http://foo/bar
|
|
@@ -135,7 +135,7 @@ quux(=3): TODO
|
|
|
135
135
|
|
|
136
136
|
my description
|
|
137
137
|
|
|
138
|
-
|
|
138
|
+
spec/controller_dsl_spec.rb:23
|
|
139
139
|
|
|
140
140
|
EOT
|
|
141
141
|
end
|
metadata
CHANGED
|
@@ -1,29 +1,28 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: betterdocs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.15.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- betterplace Developers
|
|
8
|
-
autorequire:
|
|
9
8
|
bindir: bin
|
|
10
9
|
cert_chain: []
|
|
11
|
-
date:
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
12
11
|
dependencies:
|
|
13
12
|
- !ruby/object:Gem::Dependency
|
|
14
13
|
name: gem_hadar
|
|
15
14
|
requirement: !ruby/object:Gem::Requirement
|
|
16
15
|
requirements:
|
|
17
|
-
- - "
|
|
16
|
+
- - ">="
|
|
18
17
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
18
|
+
version: 2.16.3
|
|
20
19
|
type: :development
|
|
21
20
|
prerelease: false
|
|
22
21
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
22
|
requirements:
|
|
24
|
-
- - "
|
|
23
|
+
- - ">="
|
|
25
24
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
25
|
+
version: 2.16.3
|
|
27
26
|
- !ruby/object:Gem::Dependency
|
|
28
27
|
name: rake
|
|
29
28
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -80,6 +79,20 @@ dependencies:
|
|
|
80
79
|
- - ">="
|
|
81
80
|
- !ruby/object:Gem::Version
|
|
82
81
|
version: '0'
|
|
82
|
+
- !ruby/object:Gem::Dependency
|
|
83
|
+
name: all_images
|
|
84
|
+
requirement: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - ">="
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '0'
|
|
89
|
+
type: :development
|
|
90
|
+
prerelease: false
|
|
91
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - ">="
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: '0'
|
|
83
96
|
- !ruby/object:Gem::Dependency
|
|
84
97
|
name: tins
|
|
85
98
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -220,13 +233,13 @@ extra_rdoc_files:
|
|
|
220
233
|
- lib/betterdocs/section.rb
|
|
221
234
|
- lib/betterdocs/version.rb
|
|
222
235
|
files:
|
|
236
|
+
- ".all_images.yml"
|
|
223
237
|
- ".codeclimate.yml"
|
|
224
238
|
- ".gitignore"
|
|
225
239
|
- ".rspec"
|
|
226
240
|
- ".semaphore/semaphore.yml"
|
|
227
|
-
- ".tool-versions"
|
|
228
241
|
- ".vscode/settings.json"
|
|
229
|
-
-
|
|
242
|
+
- CHANGES.md
|
|
230
243
|
- Gemfile
|
|
231
244
|
- LICENSE
|
|
232
245
|
- README.md
|
|
@@ -292,9 +305,9 @@ files:
|
|
|
292
305
|
- spec/result_representer_dsl_spec.rb
|
|
293
306
|
- spec/spec_helper.rb
|
|
294
307
|
homepage: https://github.com/betterplace/betterdocs
|
|
295
|
-
licenses:
|
|
308
|
+
licenses:
|
|
309
|
+
- Apache-2.0
|
|
296
310
|
metadata: {}
|
|
297
|
-
post_install_message:
|
|
298
311
|
rdoc_options:
|
|
299
312
|
- "--title"
|
|
300
313
|
- Betterdocs
|
|
@@ -313,8 +326,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
313
326
|
- !ruby/object:Gem::Version
|
|
314
327
|
version: '0'
|
|
315
328
|
requirements: []
|
|
316
|
-
rubygems_version:
|
|
317
|
-
signing_key:
|
|
329
|
+
rubygems_version: 4.0.3
|
|
318
330
|
specification_version: 4
|
|
319
331
|
summary: Betterplace API documentation library
|
|
320
332
|
test_files:
|
data/.tool-versions
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
ruby 3.2.5
|
data/COPYING
DELETED
|
@@ -1,202 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
Apache License
|
|
3
|
-
Version 2.0, January 2004
|
|
4
|
-
http://www.apache.org/licenses/
|
|
5
|
-
|
|
6
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
-
|
|
8
|
-
1. Definitions.
|
|
9
|
-
|
|
10
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
-
|
|
13
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
-
the copyright owner that is granting the License.
|
|
15
|
-
|
|
16
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
-
other entities that control, are controlled by, or are under common
|
|
18
|
-
control with that entity. For the purposes of this definition,
|
|
19
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
-
direction or management of such entity, whether by contract or
|
|
21
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
-
|
|
24
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
-
exercising permissions granted by this License.
|
|
26
|
-
|
|
27
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
-
including but not limited to software source code, documentation
|
|
29
|
-
source, and configuration files.
|
|
30
|
-
|
|
31
|
-
"Object" form shall mean any form resulting from mechanical
|
|
32
|
-
transformation or translation of a Source form, including but
|
|
33
|
-
not limited to compiled object code, generated documentation,
|
|
34
|
-
and conversions to other media types.
|
|
35
|
-
|
|
36
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
-
Object form, made available under the License, as indicated by a
|
|
38
|
-
copyright notice that is included in or attached to the work
|
|
39
|
-
(an example is provided in the Appendix below).
|
|
40
|
-
|
|
41
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
-
form, that is based on (or derived from) the Work and for which the
|
|
43
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
-
of this License, Derivative Works shall not include works that remain
|
|
46
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
-
the Work and Derivative Works thereof.
|
|
48
|
-
|
|
49
|
-
"Contribution" shall mean any work of authorship, including
|
|
50
|
-
the original version of the Work and any modifications or additions
|
|
51
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
-
means any form of electronic, verbal, or written communication sent
|
|
56
|
-
to the Licensor or its representatives, including but not limited to
|
|
57
|
-
communication on electronic mailing lists, source code control systems,
|
|
58
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
-
excluding communication that is conspicuously marked or otherwise
|
|
61
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
-
|
|
63
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
-
subsequently incorporated within the Work.
|
|
66
|
-
|
|
67
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
-
Work and such Derivative Works in Source or Object form.
|
|
73
|
-
|
|
74
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
-
(except as stated in this section) patent license to make, have made,
|
|
78
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
-
where such license applies only to those patent claims licensable
|
|
80
|
-
by such Contributor that are necessarily infringed by their
|
|
81
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
-
institute patent litigation against any entity (including a
|
|
84
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
-
or contributory patent infringement, then any patent licenses
|
|
87
|
-
granted to You under this License for that Work shall terminate
|
|
88
|
-
as of the date such litigation is filed.
|
|
89
|
-
|
|
90
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
-
modifications, and in Source or Object form, provided that You
|
|
93
|
-
meet the following conditions:
|
|
94
|
-
|
|
95
|
-
(a) You must give any other recipients of the Work or
|
|
96
|
-
Derivative Works a copy of this License; and
|
|
97
|
-
|
|
98
|
-
(b) You must cause any modified files to carry prominent notices
|
|
99
|
-
stating that You changed the files; and
|
|
100
|
-
|
|
101
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
-
that You distribute, all copyright, patent, trademark, and
|
|
103
|
-
attribution notices from the Source form of the Work,
|
|
104
|
-
excluding those notices that do not pertain to any part of
|
|
105
|
-
the Derivative Works; and
|
|
106
|
-
|
|
107
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
-
distribution, then any Derivative Works that You distribute must
|
|
109
|
-
include a readable copy of the attribution notices contained
|
|
110
|
-
within such NOTICE file, excluding those notices that do not
|
|
111
|
-
pertain to any part of the Derivative Works, in at least one
|
|
112
|
-
of the following places: within a NOTICE text file distributed
|
|
113
|
-
as part of the Derivative Works; within the Source form or
|
|
114
|
-
documentation, if provided along with the Derivative Works; or,
|
|
115
|
-
within a display generated by the Derivative Works, if and
|
|
116
|
-
wherever such third-party notices normally appear. The contents
|
|
117
|
-
of the NOTICE file are for informational purposes only and
|
|
118
|
-
do not modify the License. You may add Your own attribution
|
|
119
|
-
notices within Derivative Works that You distribute, alongside
|
|
120
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
-
that such additional attribution notices cannot be construed
|
|
122
|
-
as modifying the License.
|
|
123
|
-
|
|
124
|
-
You may add Your own copyright statement to Your modifications and
|
|
125
|
-
may provide additional or different license terms and conditions
|
|
126
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
-
the conditions stated in this License.
|
|
130
|
-
|
|
131
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
-
this License, without any additional terms or conditions.
|
|
135
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
-
the terms of any separate license agreement you may have executed
|
|
137
|
-
with Licensor regarding such Contributions.
|
|
138
|
-
|
|
139
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
-
except as required for reasonable and customary use in describing the
|
|
142
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
-
|
|
144
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
-
implied, including, without limitation, any warranties or conditions
|
|
149
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
-
appropriateness of using or redistributing the Work and assume any
|
|
152
|
-
risks associated with Your exercise of permissions under this License.
|
|
153
|
-
|
|
154
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
-
unless required by applicable law (such as deliberate and grossly
|
|
157
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
-
liable to You for damages, including any direct, indirect, special,
|
|
159
|
-
incidental, or consequential damages of any character arising as a
|
|
160
|
-
result of this License or out of the use or inability to use the
|
|
161
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
-
other commercial damages or losses), even if such Contributor
|
|
164
|
-
has been advised of the possibility of such damages.
|
|
165
|
-
|
|
166
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
-
or other liability obligations and/or rights consistent with this
|
|
170
|
-
License. However, in accepting such obligations, You may act only
|
|
171
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
-
defend, and hold each Contributor harmless for any liability
|
|
174
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
-
of your accepting any such warranty or additional liability.
|
|
176
|
-
|
|
177
|
-
END OF TERMS AND CONDITIONS
|
|
178
|
-
|
|
179
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
-
|
|
181
|
-
To apply the Apache License to your work, attach the following
|
|
182
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
-
replaced with your own identifying information. (Don't include
|
|
184
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
-
comment syntax for the file format. We also recommend that a
|
|
186
|
-
file or class name and description of purpose be included on the
|
|
187
|
-
same "printed page" as the copyright notice for easier
|
|
188
|
-
identification within third-party archives.
|
|
189
|
-
|
|
190
|
-
Copyright [2013] [betterplace]
|
|
191
|
-
|
|
192
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
-
you may not use this file except in compliance with the License.
|
|
194
|
-
You may obtain a copy of the License at
|
|
195
|
-
|
|
196
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
-
|
|
198
|
-
Unless required by applicable law or agreed to in writing, software
|
|
199
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
-
See the License for the specific language governing permissions and
|
|
202
|
-
limitations under the License.
|