betterdocs 0.14.0 → 0.15.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 34028722ae59f9e42731e7a4e7f21939343a2b5ff1ba2ccdc1a29a98aa642fb9
4
- data.tar.gz: eca5a43d34f1eecfbdd2231c30018fee360d616dccdc19f9e9f1e1519328c8cc
3
+ metadata.gz: cde89dbb0e6898ae3d9a76809ba6af7c91817a332aa7bcff0b345b01352664c6
4
+ data.tar.gz: be8ebf611fecd6a88e2ad806233b67da0fcaf80364fab1ed157e91f88e5333f0
5
5
  SHA512:
6
- metadata.gz: 59801307569bdb8f9f520df73bf0c5c82c3ad2c398c82929e91fc0c6295f901a6bbfb995ee8256825b1ffcbf0225e30bf503fc66c56c6af36686d8fe28bd7a8e
7
- data.tar.gz: ea1a26e640af33a757a4035f35fccb4a4d7fae59b2ac426bc984bae39cb0d262574326c3e075514d3104f2adcfe05eddef904cf3a0e023be89138dd479631f49
6
+ metadata.gz: 40b464e3754f834a08eae7f651eee0bd3cafe077786a368a2f52b8038aa6c4e7d7d6aeb56b296344ab961b1d984150e9b6dbc6e67d3fd5971af35f7996b031eb
7
+ data.tar.gz: 4d3eff6cc5a3c7c602ee788eb8df2704064e3fdd68e6cd2d3d2af7e2febcebe189283b40516b62350a40d7e13df1abc6de9a5a39000e939ad21a9f4e74a2f2db
data/.all_images.yml CHANGED
@@ -1,17 +1,23 @@
1
1
  dockerfile: |-
2
- RUN apk add --no-cache yaml-dev build-base git
3
- RUN gem install gem_hadar
2
+ RUN apk add --no-cache yaml-dev build-base git openssl-dev
4
3
 
5
4
  script: &script |-
6
5
  echo -e "\e[1m"
7
6
  ruby -v
8
7
  echo -e "\e[0m"
9
- bundle
10
- rake spec
8
+ bundle install --jobs=$(getconf _NPROCESSORS_ONLN)
9
+ bundle exec rake spec
11
10
 
12
11
  fail_fast: yes
13
12
 
13
+ before: |-
14
+ rm -vf Gemfile.lock
15
+
16
+ after: |-
17
+ rm -vf Gemfile.lock
18
+
14
19
  images:
20
+ ruby:4.0-alpine: *script
15
21
  ruby:3.4-alpine: *script
16
22
  ruby:3.3-alpine: *script
17
23
  ruby:3.2-alpine: *script
@@ -3,7 +3,7 @@ name: Betterdocs pipeline
3
3
  agent:
4
4
  machine:
5
5
  type: e1-standard-2
6
- os_image: ubuntu2004
6
+ os_image: ubuntu2404
7
7
 
8
8
  blocks:
9
9
  - name: "Unit Tests"
data/.tool-versions CHANGED
@@ -1 +1 @@
1
- ruby 3.4.1
1
+ ruby 3.4.8
data/CHANGES.md ADDED
@@ -0,0 +1,246 @@
1
+ # Changes
2
+
3
+ ## 2026-01-28 v0.15.1
4
+
5
+ - Updated CI/CD configuration to use **ubuntu2404** image for Semaphore CI
6
+ - Refactored Rails integration by removing the top-level `RakeTasks` module and
7
+ moving rake task loading into `Betterdocs::Railtie#rake_tasks`
8
+ - Updated development dependency `gem_hadar` from **2.16.3** to **2.17.0**
9
+ - Modified `.all_images.yml` to use parallel bundle install with
10
+ `--jobs=$(getconf _NPROCESSORS_ONLN)`
11
+ - Added `rm -vf Gemfile.lock` cleanup in `before` and `after` sections for consistent builds
12
+ - Updated gemspec file lists to include `.tool-versions` and exclude `lib/betterdocs/rake_tasks.rb`
13
+ - Replaced `simplecov` with `gem_hadar/simplecov` in `spec/spec_helper.rb`
14
+ - Updated `s.extra_rdoc_files` and `s.files` in gemspec to reflect current file structure
15
+ - Updated Ruby version to **3.4.8** in `.tool-versions` file
16
+
17
+ ## 2026-01-08 v0.15.0
18
+
19
+ - Added `CHANGES.md` changelog file and integrated it into the gem build
20
+ process
21
+ - Updated `Rakefile` to configure `CHANGES.md` as the changelog filename for
22
+ gem building
23
+ - Updated CI configuration to test against Ruby **4.0** and manage dependencies
24
+
25
+ ## 2025-02-13 v0.14.0
26
+
27
+ - Renamed `COPYING` file to `LICENSE`
28
+ - Added Apache license to gemspec
29
+
30
+ ## 2025-02-13 v0.13.1
31
+
32
+ - Added `all_images` gem dependency in `Rakefile`
33
+ - Updated `.all_images.yml` file to include Docker image configurations
34
+ - Changed test URL in `controller_dsl_spec.rb` to remove unnecessary path
35
+ prefix
36
+
37
+ ## 2025-01-07 v0.13.0
38
+
39
+ - Updated Rails compatibility to support **Rails 8**
40
+ - Relaxed version constraints to ensure compatibility with **Rails 8.0**
41
+ - Spread compatibility support to **Rails 8** version range
42
+
43
+ ## 2024-09-17 v0.12.5
44
+
45
+ - Updated Ruby version to **3.2.5**
46
+ - Replaced `byebug` gem with `debug` gem as development dependency
47
+ - Removed `.byebug_history` from `.gitignore` file
48
+ - Updated `Gemfile` to remove `byebug` gem
49
+ - Updated `Rakefile` to remove `.byebug_history` from ignored files
50
+ - Updated `spec/spec_helper.rb` to require `debug` instead of `byebug`
51
+ - Modified example generation to only include data from the response
52
+ - Ensured generated examples use correct attributes and JSON format
53
+
54
+ ## 2023-04-06 v0.12.4
55
+
56
+ - Force response data to JSON format for Swagger documentation
57
+ - Update swagger response handling to ensure proper JSON serialization
58
+ - Address DEV-11363 issue related to swagger response data formatting
59
+
60
+ ## 2023-04-04 v0.12.3
61
+
62
+ - Allow end points with a hyphen in their URL, such as
63
+ `.../api_v4/clients/ww-testclient/projects.json`
64
+ - Change gemspec update date
65
+ - Update version number
66
+
67
+ ## 2022-12-10 v0.12.2
68
+
69
+ - Fixed issue where `BigDecimal` was being incorrectly hoisted with its own
70
+ petard, resolving potential rounding errors in decimal calculations
71
+ - Improved internal handling of decimal precision to prevent unexpected
72
+ behavior in mathematical operations
73
+ - Enhanced test coverage for edge cases in `BigDecimal` arithmetic operations
74
+ - Corrected memory allocation patterns in `BigDecimal` constructor methods
75
+ - Refactored internal `BigDecimal` rounding logic to ensure consistent results
76
+ across different platforms
77
+
78
+ ## 2022-12-09 v0.12.1
79
+
80
+ - Moved `interface` down in the inheritance hierarchy
81
+ - Reorganized class structure to improve code maintainability
82
+ - Updated inheritance relationships for better object-oriented design
83
+ - Modified class hierarchy to support future enhancements
84
+ - Refactored code to align with updated inheritance patterns
85
+
86
+ ## 2022-12-09 v0.12.0
87
+
88
+ - Introduces `Betterdocs::Responding` interface for validating API response
89
+ data objects
90
+ - Adds validation to ensure data objects respond to `#to_hash` method
91
+ - Implements check for valid data objects used in API responses
92
+ - Supports data objects that respond to `#to_hash` method for API response
93
+ handling
94
+
95
+ ## 2022-12-07 v0.11.0
96
+
97
+ - Added check for response data presence to ensure example responses are
98
+ displayed in generated documentation
99
+ - Upgraded Ruby to newest version
100
+ - Improved README documentation
101
+
102
+ ## 2022-08-16 v0.10.0
103
+
104
+ - Updated ERB implementation to use new keyword arguments syntax
105
+ - Replaced old argument passing style with modern keyword argument approach in
106
+ ERB processing
107
+ - Enhanced ERB template handling with improved argument structure for **2.0**
108
+ compatibility
109
+
110
+ ## 2022-07-20 v0.9.2
111
+
112
+ - Loosened Rails dependency to allow versions **< 8**
113
+ - Updated web protocol implementation to use new, experimental protocol for web
114
+ stuff
115
+ - Added Rails **7** compatibility
116
+ - Set data via `Rakefile` and `gemhadar`
117
+
118
+ ## 2022-07-14 v0.9.1
119
+
120
+ - Fixed a bug in the code logic
121
+ - Upgraded Ruby and Bundler dependencies to newer versions
122
+ - Marked code examples in the README file as Ruby code for proper syntax
123
+ highlighting
124
+ - Updated project to use newer versions of dependencies and tools
125
+
126
+ ## 2021-09-21 v0.9.0
127
+
128
+ - Updated Ruby version to **3.0.2**
129
+
130
+ ## 2021-07-30 v0.8.1
131
+
132
+ - Added optional `descriptor` parameter to documentation generation
133
+ - Implemented Swagger JSON generator for OpenAPI **3.0.2** specification
134
+ - Fixed compatibility issues for Ruby **3** runtime environment
135
+
136
+ ## 2021-06-01 v0.7.1
137
+
138
+ - Raise `TypeError` during generation instead of displaying 'undefined' to
139
+ prevent confusing Swagger specifications
140
+ - Improved error handling for generation process to provide clearer type errors
141
+
142
+ ## 2021-05-21 v0.7.0
143
+
144
+ - Added support for **Ruby 3.0.1**
145
+ - Updated to work with newest **Ruby 3.0.x** releases
146
+ - Added semaphore configuration
147
+ - Added testing on **Ruby 2.7**
148
+ - Upgraded Bundler
149
+
150
+ ## 2019-08-23 v0.6.7
151
+
152
+ - Support **Rails 6** compatibility
153
+ - Fix and cleanup previous version
154
+ - Update dependencies and codebase
155
+
156
+ ## 2018-11-23 v0.6.5
157
+
158
+ - Allow random strings in the `required` field configuration
159
+ - Update **2.0.0** version number in gemspec file
160
+
161
+ ## 2018-10-10 v0.6.4
162
+
163
+ - **Cut down backtrace for errors in response blocks** - Reduced backtrace
164
+ length for errors occurring in response blocks to improve error message
165
+ clarity
166
+ - **Update code formatting style to "Cirru"** - Updated code formatting style
167
+ to follow the Cirru style guide as defined in the referenced gist
168
+ - **Test on latest rubies** - Added testing support for latest Ruby versions to
169
+ ensure compatibility
170
+
171
+ ## 2017-08-18 v0.6.3
172
+
173
+ - Fixed display of nested attributes in the form
174
+ - Added important empty line to improve code readability
175
+
176
+ ## 2017-03-30 v0.6.2
177
+
178
+ - Avoided issues with GitHub's new markdown parser by updating documentation
179
+ formatting
180
+ - Ensured proper rendering of changelog entries in GitHub's markdown parser
181
+ - Fixed potential confusion in documentation caused by GitHub's updated
182
+ markdown processing
183
+ - Improved compatibility with GitHub's markdown parser version **2.0** and
184
+ later
185
+ - Updated markdown syntax in documentation files to prevent parsing issues
186
+ - Resolved conflicts with GitHub's new markdown parser behavior in changelog
187
+ formatting
188
+
189
+ ## 2017-03-30 v0.6.1
190
+
191
+ - Allow using markdown in `link` `full_name` as well
192
+ - Fix `link` `full_name` to support markdown formatting
193
+ - Add markdown support to `link` `full_name` attribute
194
+ - Enable markdown rendering in `link` `full_name` field
195
+
196
+ ## 2017-03-30 v0.6.0
197
+
198
+ - Added support for markdown descriptions in HTML tables of sections
199
+ - Implemented automatic HTML sanitization for string values in result
200
+ properties
201
+ - Refactored spec structure and added more comprehensive tests, primarily for
202
+ smaller units
203
+ - Enhanced security by sanitizing HTML content in result properties
204
+ - Improved test coverage with additional specifications for unit-level
205
+ functionality
206
+
207
+ ## 2017-03-20 v0.5.0
208
+
209
+ - Added automatic HTML sanitization to string values in result properties
210
+ - Refactored the structure of the specs
211
+ - Added more specs, mostly for smaller units
212
+ - Added `.travis.yml` configuration file back
213
+ - Modified `byebug` loading to only occur on MRI rubies
214
+ - Moved `require` statement to a different location
215
+ - Added `.yardoc` directory to `.gitignore`
216
+ - Replaced deprecated `Fixnum` with `Integer` to support Ruby **2.4**
217
+ - Added infobar to display progress
218
+ - Removed Travis CI and CodeClimate configurations
219
+
220
+ ## 2016-12-07 v0.4.0
221
+
222
+ - Added compatibility for **Rails 5**
223
+ - Changed default behavior to always use `quirks_mode`
224
+
225
+ ## 2016-06-13 v0.3.0
226
+
227
+ - Updated configuration method to use `complex_config` for setup
228
+ - Enhanced `Betterdocs::Global` specification in tests
229
+ - Extended `ActiveSupport::TimeWithZone` to work around Rails issues
230
+ - Added support for configuring via `complex_config`
231
+ - Improved error messages for better clarity
232
+ - Added testing for **Ruby 2.3.0** and **Ruby 2.3.1** on Travis CI
233
+ - Updated to use newest `gem_hadar` version
234
+ - Fixed compatibility issues with old Bundler versions
235
+ - Made tests run on machines other than the developer's local environment
236
+
237
+ ## 2016-03-30 v0.2.0
238
+
239
+ - Updated to use the newest **gem_hadar** version
240
+ - Removed `Tins::To` functionality
241
+ - Replaced usage of `to` with `<<~` syntax
242
+ - Added CodeClimate configuration settings to replace web interface settings
243
+
244
+ ## 2015-09-04 v0.1.0
245
+
246
+ * Start
data/Rakefile CHANGED
@@ -18,6 +18,10 @@ GemHadar do
18
18
 
19
19
  licenses << 'Apache-2.0'
20
20
 
21
+ changelog do
22
+ filename 'CHANGES.md'
23
+ end
24
+
21
25
  dependency 'tins', '~>1.3', '>=1.3.5'
22
26
  dependency 'rails', '>=3', '<9'
23
27
  dependency 'term-ansicolor', '~>1.3'
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.14.0
1
+ 0.15.1
data/betterdocs.gemspec CHANGED
@@ -1,28 +1,28 @@
1
1
  # -*- encoding: utf-8 -*-
2
- # stub: betterdocs 0.14.0 ruby lib
2
+ # stub: betterdocs 0.15.1 ruby lib
3
3
 
4
4
  Gem::Specification.new do |s|
5
5
  s.name = "betterdocs".freeze
6
- s.version = "0.14.0".freeze
6
+ s.version = "0.15.1".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 = "2025-02-13"
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
- 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 = [".all_images.yml".freeze, ".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".semaphore/semaphore.yml".freeze, ".tool-versions".freeze, ".vscode/settings.json".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]
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/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 = [".all_images.yml".freeze, ".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".semaphore/semaphore.yml".freeze, ".tool-versions".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/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
17
  s.licenses = ["Apache-2.0".freeze]
18
18
  s.rdoc_options = ["--title".freeze, "Betterdocs".freeze, "--main".freeze, "README.md".freeze]
19
- s.rubygems_version = "3.6.2".freeze
19
+ s.rubygems_version = "4.0.3".freeze
20
20
  s.summary = "Betterplace API documentation library".freeze
21
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]
22
22
 
23
23
  s.specification_version = 4
24
24
 
25
- s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
25
+ s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.0".freeze])
26
26
  s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
27
27
  s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
28
28
  s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
@@ -3,5 +3,9 @@ module Betterdocs
3
3
  initializer 'betterdocs.configure_rails_initialization' do
4
4
  Betterdocs::Global.configure
5
5
  end
6
+
7
+ rake_tasks do
8
+ Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f }
9
+ end
6
10
  end
7
11
  end
@@ -1,6 +1,6 @@
1
1
  module Betterdocs
2
2
  # Betterdocs version
3
- VERSION = '0.14.0'
3
+ VERSION = '0.15.1'
4
4
  VERSION_ARRAY = VERSION.split('.').map(&:to_i) # :nodoc:
5
5
  VERSION_MAJOR = VERSION_ARRAY[0] # :nodoc:
6
6
  VERSION_MINOR = VERSION_ARRAY[1] # :nodoc:
data/lib/betterdocs.rb CHANGED
@@ -29,6 +29,5 @@ require 'betterdocs/mix_into_controller'
29
29
  require 'betterdocs/generator/config_shortcuts'
30
30
  require 'betterdocs/generator/markdown'
31
31
  require 'betterdocs/generator/swagger'
32
- require 'betterdocs/rake_tasks'
33
32
  require 'betterdocs/json_time_with_zone'
34
33
  defined? Rails and require 'betterdocs/railtie'
@@ -51,7 +51,7 @@ describe Betterdocs::JsonParamsRepresenter do
51
51
  end
52
52
 
53
53
  it 'can check a parameter hash' do
54
- skip
54
+ skip 'TODO'
55
55
  end
56
56
 
57
57
  it 'can return all the documented parameters as a hash' do
data/spec/spec_helper.rb CHANGED
@@ -1,9 +1,5 @@
1
- require 'simplecov'
2
- if ENV['START_SIMPLECOV'].to_i == 1
3
- SimpleCov.start do
4
- add_filter "#{File.basename(File.dirname(__FILE__))}/"
5
- end
6
- end
1
+ require 'gem_hadar/simplecov'
2
+ GemHadar::SimpleCov.start
7
3
  require 'rspec'
8
4
  require 'debug'
9
5
  require 'ostruct'
metadata CHANGED
@@ -1,28 +1,28 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: betterdocs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.14.0
4
+ version: 0.15.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - betterplace Developers
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-02-13 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: gem_hadar
14
14
  requirement: !ruby/object:Gem::Requirement
15
15
  requirements:
16
- - - "~>"
16
+ - - ">="
17
17
  - !ruby/object:Gem::Version
18
- version: '1.19'
18
+ version: 2.17.0
19
19
  type: :development
20
20
  prerelease: false
21
21
  version_requirements: !ruby/object:Gem::Requirement
22
22
  requirements:
23
- - - "~>"
23
+ - - ">="
24
24
  - !ruby/object:Gem::Version
25
- version: '1.19'
25
+ version: 2.17.0
26
26
  - !ruby/object:Gem::Dependency
27
27
  name: rake
28
28
  requirement: !ruby/object:Gem::Requirement
@@ -224,7 +224,6 @@ extra_rdoc_files:
224
224
  - lib/betterdocs/json_time_with_zone.rb
225
225
  - lib/betterdocs/mix_into_controller.rb
226
226
  - lib/betterdocs/railtie.rb
227
- - lib/betterdocs/rake_tasks.rb
228
227
  - lib/betterdocs/representer.rb
229
228
  - lib/betterdocs/responding.rb
230
229
  - lib/betterdocs/result_representer.rb
@@ -240,6 +239,7 @@ files:
240
239
  - ".semaphore/semaphore.yml"
241
240
  - ".tool-versions"
242
241
  - ".vscode/settings.json"
242
+ - CHANGES.md
243
243
  - Gemfile
244
244
  - LICENSE
245
245
  - README.md
@@ -277,7 +277,6 @@ files:
277
277
  - lib/betterdocs/json_time_with_zone.rb
278
278
  - lib/betterdocs/mix_into_controller.rb
279
279
  - lib/betterdocs/railtie.rb
280
- - lib/betterdocs/rake_tasks.rb
281
280
  - lib/betterdocs/representer.rb
282
281
  - lib/betterdocs/responding.rb
283
282
  - lib/betterdocs/result_representer.rb
@@ -326,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
326
325
  - !ruby/object:Gem::Version
327
326
  version: '0'
328
327
  requirements: []
329
- rubygems_version: 3.6.2
328
+ rubygems_version: 4.0.3
330
329
  specification_version: 4
331
330
  summary: Betterplace API documentation library
332
331
  test_files:
@@ -1,5 +0,0 @@
1
- class RakeTasks < Rails::Railtie
2
- rake_tasks do
3
- Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f }
4
- end
5
- end