betterdocs 0.6.5 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f27d6a996467614b0d43ebd711b6f0be5e7e7d29efd3c0c4d81a2bcf2cb322f0
-  data.tar.gz: 1c4edbf07396e2c5f348e3f6d870858f955fac90a1f3af01722f573b6e617796
+  metadata.gz: 84f61a235deb0348813dd4ccfc102e41e08ce374b3bcc7d48991935d08f1ce17
+  data.tar.gz: dee9b3cfb105cea04192377d5f1b11306aee02da2165bc85c78eeaa2d239089c
 SHA512:
-  metadata.gz: 589cbf4e37bd16738b720764fb557246a0d64da4d97870acda691415732cf076142b0b35c1d67a4b9ebea3f86d46687d4492c6e99e71bf351da2b36382f78334
-  data.tar.gz: 497d6f2700598b5e317237cde10d02bcab7280e3818a9f9a887dede92f9bdf2c065cca4d5a70784ab12b9fad5bab65b663015b2097799003ff346799d2f9b9f5
+  metadata.gz: ca0afd3ada7b6852b0dda51e73457f37144b0c851fba52da52177ab81f76d22afe9f322b17f9e5a1d5fb965c7c0c4d0439a708fc112dd18de474880a2b97c711
+  data.tar.gz: c095d79714edc2c0cc66eae7bd7c76b4f6791d989f20826a0081e6c7661d928744dfd260d4be03884a6955bcfbffcbe1639fc52b02993b952e0f06c75b9b5117

data/.semaphore/semaphore.yml

@@ -0,0 +1,26 @@
+version: v1.0
+name: Betterdocs pipeline
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+
+blocks:
+  - name: "Unit Tests"
+    task:
+      env_vars:
+        # Matches the configuration used in sem-service
+        - name: RAILS_ENV
+          value: test
+      jobs:
+      - name: RSpec
+        commands:
+          - checkout
+
+          # Setup ruby
+          - sem-version ruby $(awk '/^ruby/ { print $2 }' .tool-versions)
+
+          # Setup gems
+          - bundle config set path 'vendor/bundle'
+          - bundle install
+          - bundle exec rake spec

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.1

data/README.md

@@ -6,7 +6,7 @@ Betterdocs API Documentation
 DESCRIPTION
 -----------
 
-This library can be used to document a rails based API.
+This library can be used to document a Rails-based API.
 
 LICENSE
 -------
@@ -40,12 +40,12 @@ This api generator requires that you follow the [representer pattern](http://nic
         end
 
         response do
-          generate_fake_result_with_representer 
+          generate_fake_result_with_representer
         end
       end
       # :nocov:
       def index
-        render json: real_result_with_representer 
+        render json: real_result_with_representer
       end
 
       # :nocov: Documentation
@@ -68,7 +68,7 @@ This api generator requires that you follow the [representer pattern](http://nic
       end
       # :nocov:
       def show
-        render json: real_result_with_representer 
+        render json: real_result_with_representer
       end
     end
 

data/Rakefile

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

data/VERSION

@@ -1 +1 @@
-0.6.5
+0.7.1

data/betterdocs.gemspec

@@ -1,57 +1,46 @@
 # -*- encoding: utf-8 -*-
-# stub: betterdocs 0.6.5 ruby lib
+# stub: betterdocs 0.7.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterdocs".freeze
-  s.version = "0.6.5"
+  s.version = "0.7.1"
 
   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 = "2018-11-23"
+  s.date = "2021-06-01"
   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/sanitizer.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/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.files = [".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".semaphore/semaphore.yml".freeze, ".tool-versions".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/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 = "http://github.com/betterplace/betterdocs".freeze
   s.rdoc_options = ["--title".freeze, "Betterdocs".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "2.7.6".freeze
+  s.rubygems_version = "3.2.15".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
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-      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.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"])
-      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.9.1"])
-      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.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"])
-      s.add_dependency(%q<infobar>.freeze, [">= 0"])
-      s.add_dependency(%q<mize>.freeze, [">= 0"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.11.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", "< 7"])
+    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.9.1"])
+    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.11.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.5", "~> 1.3"])
-    s.add_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
+    s.add_dependency(%q<tins>.freeze, ["~> 1.3", ">= 1.3.5"])
+    s.add_dependency(%q<rails>.freeze, [">= 3", "< 7"])
     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"])

data/lib/betterdocs/dsl/json_params/param.rb

@@ -25,9 +25,7 @@ class Betterdocs::Dsl::JsonParams::Param < Betterdocs::Dsl::Representer
 
   def compute_value(object)
     value = object.__send__(name)
-    if ActiveSupport::TimeWithZone === value
-      value.extend Betterdocs::JsonTimeWithZone
-    end
+    value.respond_to?(:iso8601) and value.extend Betterdocs::JsonTimeWithZone
     value
   end
 

data/lib/betterdocs/dsl/json_type_mapper.rb

@@ -13,7 +13,7 @@ module Betterdocs::Dsl::JsonTypeMapper
       String     => 'string',
     }.find { |match_class, json_type|
       match_class >= klass and break json_type
-    } || 'undefined'
+    } or raise TypeError, "Invalid type #{klass} encountered. Use a type that can be mapped to JSON instead."
   end
 
   def map_types(types)

data/lib/betterdocs/dsl/result/property.rb

@@ -46,7 +46,7 @@ class Betterdocs::Dsl::Result::Property < Betterdocs::Dsl::Representer
     value.nil? and return
     if represent_with
       represent_with.hashify(value)
-    elsif ActiveSupport::TimeWithZone === value
+    elsif value.respond_to?(:iso8601)
       value.extend Betterdocs::JsonTimeWithZone
     else
       sanitizer.sanitize(value)

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

@@ -62,8 +62,6 @@ are optional.
     <td><code><%= param.types * ?| -%></code></td>
     <td>
       <%=
-        puts param.name
-        puts param.required.inspect
         case param.required
         when String then param.required
         when true then 'yes'

data/lib/betterdocs/representer.rb

@@ -30,7 +30,7 @@ module Betterdocs::Representer
     end
 
     def doc(type, name, **options, &block)
-      docs.add_element(self, type, name, options, &block)
+      docs.add_element(self, type, name, **options, &block)
     end
 
     def object_name(*) end

data/lib/betterdocs/result_representer.rb

@@ -15,7 +15,7 @@ module Betterdocs::ResultRepresenter
     end
 
     def doc(type, name, **options, &block)
-      docs.add_element(self, type, name, options, &block)
+      docs.add_element(self, type, name, **options, &block)
     end
 
     def docs

data/lib/betterdocs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterdocs
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.1
 platform: ruby
 authors:
 - betterplace Developers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-23 00:00:00.000000000 Z
+date: 2021-06-01 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.9.1
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -105,7 +105,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -207,7 +207,8 @@ files:
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".semaphore/semaphore.yml"
+- ".tool-versions"
 - COPYING
 - Gemfile
 - LICENSE
@@ -273,7 +274,7 @@ files:
 homepage: http://github.com/betterplace/betterdocs
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - Betterdocs
@@ -292,9 +293,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Betterplace API documentation library
 test_files:

data/.travis.yml

@@ -1,9 +0,0 @@
-before_install:
-  - gem update --system
-  - gem update bundler
-
-rvm:
-  - 2.4.3
-  - 2.5.0
-
-sudo: false