betterdocs 0.12.3 → 0.12.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09843f4452a097ec22304ec23e813656de04f1716ede9ea25106fb539c981e07'
-  data.tar.gz: 34da0046689ff95259b7b87ee7ff095be313a719d172ba1be5c2454affed8d76
+  metadata.gz: 325ee2f151c3fe3b64248fe9dac07fa10ecbd5ebe499a4c6c811c1f714c4c863
+  data.tar.gz: 543a3f43138aaf8597e8d866d6dc7ae9b0722a97c5d2a375d7409792c8dc145b
 SHA512:
-  metadata.gz: ede4fcf3be815102e61594cfe8f6e4f26eb5030ac6800f2684581559e46b924f2d5b22d43add42e3c49400c326f3aabd21951d497742c2d14bdd23ee7b0d9bbd
-  data.tar.gz: 4621fca772948c34d7bdb8888b3580e70199a1a9e3fa52e560b18d647ff121ad9229580daf2326d1c9068ac0b1c70bcc1063011013191e4583b802db3fc8da4c
+  metadata.gz: dc1aaae1a2aa1bb580b351d93578a48ac20798abf9c35fc80994b601e9d983c8f850b6cc0a2c7c5410a7e4687dc39a17e96f6b63ff24238addc2e94bcb71912d
+  data.tar.gz: 78ddf9fc8116c9483c0b4f2fa7ba24190cc2ed639df05656088428ceb7ab2a9a8a978c89ca11adb4eac8a8da512f7d542c188f8e60688db63a937132fe71d8a9

data/.gitignore

@@ -2,7 +2,6 @@
 .AppleDouble
 .DS_Store
 .bundle
-.byebug_history
 .history
 .ruby-version
 .rvmrc

data/.tool-versions

@@ -1,2 +1 @@
-ruby 3.1.3
-bundler 2.3.17
+ruby 3.2.5

data/Gemfile

@@ -3,5 +3,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'byebug', platform: 'mri'

data/Rakefile

@@ -12,7 +12,7 @@ GemHadar do
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
     '.ruby-version', '.AppleDouble', 'tags', '.DS_Store', '.utilsrc',
-    '.bundle', '.byebug_history', 'errors.lst', '.yardoc', '.history'
+    '.bundle', 'errors.lst', '.yardoc', '.history'
   readme      'README.md'
   title       "#{name.camelize}"
 
@@ -25,6 +25,7 @@ GemHadar do
   development_dependency 'rake'
   development_dependency 'simplecov'
   development_dependency 'rspec'
+  development_dependency 'debug'
 end
 
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.12.3
+0.12.5

data/betterdocs.gemspec

@@ -1,49 +1,35 @@
 # -*- encoding: utf-8 -*-
-# stub: betterdocs 0.12.3 ruby lib
+# stub: betterdocs 0.12.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterdocs".freeze
-  s.version = "0.12.3"
+  s.version = "0.12.5".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["betterplace Developers".freeze]
-  s.date = "2023-04-04"
+  s.date = "2024-09-17"
   s.description = "This library provides tools to generate API documention for a web site's REST-ful JSON API.".freeze
   s.email = "developers@betterplace.org".freeze
   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]
   s.files = [".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".semaphore/semaphore.yml".freeze, ".tool-versions".freeze, ".vscode/settings.json".freeze, "COPYING".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]
   s.homepage = "https://github.com/betterplace/betterdocs".freeze
   s.rdoc_options = ["--title".freeze, "Betterdocs".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.3.26".freeze
+  s.rubygems_version = "3.5.18".freeze
   s.summary = "Betterplace API documentation library".freeze
   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]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
+  s.specification_version = 4
 
-  if s.respond_to? :add_runtime_dependency then
-    s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.12.0"])
-    s.add_development_dependency(%q<rake>.freeze, [">= 0"])
-    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-    s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.3", ">= 1.3.5"])
-    s.add_runtime_dependency(%q<rails>.freeze, [">= 3", "< 8"])
-    s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
-    s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.5"])
-    s.add_runtime_dependency(%q<infobar>.freeze, [">= 0"])
-    s.add_runtime_dependency(%q<mize>.freeze, [">= 0"])
-  else
-    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.12.0"])
-    s.add_dependency(%q<rake>.freeze, [">= 0"])
-    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
-    s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<tins>.freeze, ["~> 1.3", ">= 1.3.5"])
-    s.add_dependency(%q<rails>.freeze, [">= 3", "< 8"])
-    s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
-    s.add_dependency(%q<complex_config>.freeze, ["~> 0.5"])
-    s.add_dependency(%q<infobar>.freeze, [">= 0"])
-    s.add_dependency(%q<mize>.freeze, [">= 0"])
-  end
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.17.1".freeze])
+  s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.3".freeze, ">= 1.3.5".freeze])
+  s.add_runtime_dependency(%q<rails>.freeze, [">= 3".freeze, "< 8".freeze])
+  s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.3".freeze])
+  s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.5".freeze])
+  s.add_runtime_dependency(%q<infobar>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<mize>.freeze, [">= 0".freeze])
 end

data/lib/betterdocs/generator/markdown/templates/section.md.erb

@@ -154,7 +154,7 @@ are optional.
 ## Response Example
 
 ```json
-<%= JSON.pretty_generate(action.response, quirks_mode: true) %>
+<%= JSON.pretty_generate(action.response.data.as_json, quirks_mode: true) %>
 ```
 
 <%- end -%>

data/lib/betterdocs/generator/swagger.rb

@@ -367,7 +367,7 @@ module Betterdocs
           end
           ok = { schema: schema }
           unless action.response.nil?
-            add_example(ok, 'example', JSON.parse(JSON.pretty_generate(action.response, quirks_mode: true)))
+            add_example(ok, 'example', JSON.parse(JSON.pretty_generate(action.response.to_json, quirks_mode: true)))
           end
           p[:responses] =
             { "200": wrap_content_object(ok, 'OK'),

data/lib/betterdocs/version.rb

@@ -1,6 +1,6 @@
 module Betterdocs
   # Betterdocs version
-  VERSION         = '0.12.3'
+  VERSION         = '0.12.5'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/spec_helper.rb

@@ -5,7 +5,8 @@ if ENV['START_SIMPLECOV'].to_i == 1
   end
 end
 require 'rspec'
-require 'byebug'
+require 'debug'
+require 'ostruct'
 require 'betterdocs'
 
 RSpec.configure do |c|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterdocs
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.12.5
 platform: ruby
 authors:
 - betterplace Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.17.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement
@@ -299,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Betterplace API documentation library