betterdocs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3db95985948a6ea7f7ef6fedb7057c9403c51629
-  data.tar.gz: 6a6bb0a36b82481e1e7451e533423ab00d765d95
+  metadata.gz: a2dce2da10a7aa53142585ae1bcd71e01647ac0a
+  data.tar.gz: 39cc4830e670c791553e3b2fc6682dac1f9f0d35
 SHA512:
-  metadata.gz: 6515adc1cf8a4faeb58e15acc26dc7129f5658b990cd2bf42506f1fb6508df219dbf87645772cbbd7cb2373c0272d35ba1ba05830a8246f7f9b9ac050f3c7243
-  data.tar.gz: 7914bad33f84a4a36aff48cb2173ab89d47b8d1c64dcb72143ee68bc4c776d200590eb9635265232dfc249b566a2930227760bd1b0c7a8b8f60b36d75b56ee59
+  metadata.gz: 14435b08ce425e42850d60294b562626fcbd0a74b9ac3df8f8a468b43cfb204607cb73a8590d74223cbd35acd38c3438a362cc531db4017450a70288abcf1456
+  data.tar.gz: 76eb043df9dc0017a110e3d4f416d67f6f4f40eaeaea2447825b034e36a134fccdfa50e6f64b06db1e2892a8ba59e40e10844bd5730451b7c37171a1c4d95077

data/Rakefile

@@ -17,7 +17,7 @@ GemHadar do
   title       "#{name.camelize} -- "
 
   dependency 'tins',           '~>1.3', '>=1.3.5'
-  dependency 'rails',          '>=3', '<5'
+  dependency 'rails',          '>=3', '<6'
   dependency 'term-ansicolor', '~>1.3'
   dependency 'complex_config', '~>0.5'
   development_dependency 'simplecov'

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/betterdocs.gemspec

@@ -1,51 +1,51 @@
 # -*- encoding: utf-8 -*-
-# stub: betterdocs 0.3.0 ruby lib
+# stub: betterdocs 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "betterdocs"
-  s.version = "0.3.0"
+  s.name = "betterdocs".freeze
+  s.version = "0.4.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["betterplace Developers"]
-  s.date = "2016-06-13"
-  s.description = "This library provides tools to generate API documention for a web site's REST-ful JSON API."
-  s.email = "developers@betterplace.org"
-  s.extra_rdoc_files = ["README.md", "lib/betterdocs.rb", "lib/betterdocs/controller_collector.rb", "lib/betterdocs/dsl.rb", "lib/betterdocs/dsl/common.rb", "lib/betterdocs/dsl/controller.rb", "lib/betterdocs/dsl/controller/action.rb", "lib/betterdocs/dsl/controller/action/param.rb", "lib/betterdocs/dsl/controller/action/response.rb", "lib/betterdocs/dsl/controller/controller.rb", "lib/betterdocs/dsl/controller/controller_base.rb", "lib/betterdocs/dsl/json_params.rb", "lib/betterdocs/dsl/json_params/param.rb", "lib/betterdocs/dsl/json_type_mapper.rb", "lib/betterdocs/dsl/naming.rb", "lib/betterdocs/dsl/representer.rb", "lib/betterdocs/dsl/result.rb", "lib/betterdocs/dsl/result/collection_property.rb", "lib/betterdocs/dsl/result/link.rb", "lib/betterdocs/dsl/result/property.rb", "lib/betterdocs/generator/config_shortcuts.rb", "lib/betterdocs/generator/markdown.rb", "lib/betterdocs/global.rb", "lib/betterdocs/json_params_representer.rb", "lib/betterdocs/json_params_representer_collector.rb", "lib/betterdocs/json_time_with_zone.rb", "lib/betterdocs/mix_into_controller.rb", "lib/betterdocs/railtie.rb", "lib/betterdocs/rake_tasks.rb", "lib/betterdocs/representer.rb", "lib/betterdocs/result_representer.rb", "lib/betterdocs/result_representer_collector.rb", "lib/betterdocs/section.rb", "lib/betterdocs/version.rb"]
-  s.files = [".codeclimate.yml", ".gitignore", ".rspec", ".travis.yml", "COPYING", "Gemfile", "LICENSE", "README.md", "Rakefile", "VERSION", "betterdocs.gemspec", "lib/betterdocs.rb", "lib/betterdocs/controller_collector.rb", "lib/betterdocs/dsl.rb", "lib/betterdocs/dsl/common.rb", "lib/betterdocs/dsl/controller.rb", "lib/betterdocs/dsl/controller/action.rb", "lib/betterdocs/dsl/controller/action/param.rb", "lib/betterdocs/dsl/controller/action/response.rb", "lib/betterdocs/dsl/controller/controller.rb", "lib/betterdocs/dsl/controller/controller_base.rb", "lib/betterdocs/dsl/json_params.rb", "lib/betterdocs/dsl/json_params/param.rb", "lib/betterdocs/dsl/json_type_mapper.rb", "lib/betterdocs/dsl/naming.rb", "lib/betterdocs/dsl/representer.rb", "lib/betterdocs/dsl/result.rb", "lib/betterdocs/dsl/result/collection_property.rb", "lib/betterdocs/dsl/result/link.rb", "lib/betterdocs/dsl/result/property.rb", "lib/betterdocs/generator/config_shortcuts.rb", "lib/betterdocs/generator/markdown.rb", "lib/betterdocs/generator/markdown/templates/README.md.erb", "lib/betterdocs/generator/markdown/templates/section.md.erb", "lib/betterdocs/global.rb", "lib/betterdocs/json_params_representer.rb", "lib/betterdocs/json_params_representer_collector.rb", "lib/betterdocs/json_time_with_zone.rb", "lib/betterdocs/mix_into_controller.rb", "lib/betterdocs/railtie.rb", "lib/betterdocs/rake_tasks.rb", "lib/betterdocs/representer.rb", "lib/betterdocs/result_representer.rb", "lib/betterdocs/result_representer_collector.rb", "lib/betterdocs/section.rb", "lib/betterdocs/tasks/doc.rake", "lib/betterdocs/version.rb", "spec/assets/app/controllers/api/foos_controller.rb", "spec/assets/config/betterdocs.yml", "spec/controller_dsl_spec.rb", "spec/generator/markdown_spec.rb", "spec/global_spec.rb", "spec/json_params_representer_spec.rb", "spec/json_type_mapper_spec.rb", "spec/result_representer_dsl_spec.rb", "spec/result_representer_spec.rb", "spec/spec_helper.rb"]
-  s.homepage = "http://github.com/betterplace/betterdocs"
-  s.rdoc_options = ["--title", "Betterdocs -- ", "--main", "README.md"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "Betterplace API documentation library"
-  s.test_files = ["spec/assets/app/controllers/api/foos_controller.rb", "spec/controller_dsl_spec.rb", "spec/generator/markdown_spec.rb", "spec/global_spec.rb", "spec/json_params_representer_spec.rb", "spec/json_type_mapper_spec.rb", "spec/result_representer_dsl_spec.rb", "spec/result_representer_spec.rb", "spec/spec_helper.rb"]
+  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 = "2016-12-07"
+  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/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/result_representer.rb".freeze, "lib/betterdocs/result_representer_collector.rb".freeze, "lib/betterdocs/section.rb".freeze, "lib/betterdocs/version.rb".freeze]
+  s.files = [".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".travis.yml".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/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/result_representer.rb".freeze, "lib/betterdocs/result_representer_collector.rb".freeze, "lib/betterdocs/section.rb".freeze, "lib/betterdocs/tasks/doc.rake".freeze, "lib/betterdocs/version.rb".freeze, "spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/assets/config/betterdocs.yml".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/generator/markdown_spec.rb".freeze, "spec/global_spec.rb".freeze, "spec/json_params_representer_spec.rb".freeze, "spec/json_type_mapper_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/result_representer_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.homepage = "http://github.com/betterplace/betterdocs".freeze
+  s.rdoc_options = ["--title".freeze, "Betterdocs -- ".freeze, "--main".freeze, "README.md".freeze]
+  s.rubygems_version = "2.6.8".freeze
+  s.summary = "Betterplace API documentation library".freeze
+  s.test_files = ["spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/generator/markdown_spec.rb".freeze, "spec/global_spec.rb".freeze, "spec/json_params_representer_spec.rb".freeze, "spec/json_type_mapper_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/result_representer_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<gem_hadar>, ["~> 1.7.1"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_runtime_dependency(%q<tins>, [">= 1.3.5", "~> 1.3"])
-      s.add_runtime_dependency(%q<rails>, ["< 5", ">= 3"])
-      s.add_runtime_dependency(%q<term-ansicolor>, ["~> 1.3"])
-      s.add_runtime_dependency(%q<complex_config>, ["~> 0.5"])
+      s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
+      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.5", "~> 1.3"])
+      s.add_runtime_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
+      s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
+      s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.5"])
     else
-      s.add_dependency(%q<gem_hadar>, ["~> 1.7.1"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<tins>, [">= 1.3.5", "~> 1.3"])
-      s.add_dependency(%q<rails>, ["< 5", ">= 3"])
-      s.add_dependency(%q<term-ansicolor>, ["~> 1.3"])
-      s.add_dependency(%q<complex_config>, ["~> 0.5"])
+      s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<tins>.freeze, [">= 1.3.5", "~> 1.3"])
+      s.add_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
+      s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
+      s.add_dependency(%q<complex_config>.freeze, ["~> 0.5"])
     end
   else
-    s.add_dependency(%q<gem_hadar>, ["~> 1.7.1"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<tins>, [">= 1.3.5", "~> 1.3"])
-    s.add_dependency(%q<rails>, ["< 5", ">= 3"])
-    s.add_dependency(%q<term-ansicolor>, ["~> 1.3"])
-    s.add_dependency(%q<complex_config>, ["~> 0.5"])
+    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<tins>.freeze, [">= 1.3.5", "~> 1.3"])
+    s.add_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
+    s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
+    s.add_dependency(%q<complex_config>.freeze, ["~> 0.5"])
   end
 end

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

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

data/lib/betterdocs/json_params_representer.rb

@@ -4,7 +4,7 @@ module Betterdocs::JsonParamsRepresenter
 
   module ClassMethods
     def build_result_object
-      ActionController::Parameters.new
+      {}.with_indifferent_access
     end
 
     def hashify(object)

data/lib/betterdocs/version.rb

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

data/spec/json_params_representer_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe Betterdocs::JsonParamsRepresenter do
   end
 
   it 'can be converted into a ActionController::Parameters instance' do
-    expect(object.as_json).to be_a ActionController::Parameters
+    expect(object.as_json).to be_a HashWithIndifferentAccess
   end
 
   it 'it can be turned into a hash' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterdocs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-12-07 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.7.1
+        version: 1.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: 1.9.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +91,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Betterplace API documentation library