dox 2.0.0.beta2 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dafc7bfd7720a7ee11971214fd0f482a83b58716d400bd6a566dfbcc4f557147
-  data.tar.gz: 47f3effad46183ad8b6869d2f4c84f12bff4ecb99d067cedc63742b8ad004696
+  metadata.gz: 19d606ce8e741ff8f4844e0a0f2bff86cda870356417fb20254dad8030865f21
+  data.tar.gz: 3d57f29f50c860c4d5781e5990b398e984461d8b8239b3b82885d5df89fc8414
 SHA512:
-  metadata.gz: 0ffb07d32e950510576d6899fdaadd19ee422345dc731aae9d1e07a0cc83d5c3af812dc4265badd991b6b1b601a44d4762d0ddbcb6aae7120d56fa349a5dec49
-  data.tar.gz: 36776866e234e06fcfe984af6f419c344041d8a143e1c13ad7e179c4ee72f87ac99cd6174d51dc144984644836044c64e6243a2d5a3c6cb3b0eb737813ffd4a6
+  metadata.gz: 3c520ed0ca05c9b2eab780ef3feef96a937277912ad97e460ded62cd4dfa2c455675a937ccb299b8776140b6f38657aacc67c3430e6c3e0004f7e2af53a20da3
+  data.tar.gz: 7b288f580fa957a06764cc9d0df09c6fb6d914d43743b4fe58ee0666f614e96ad34cdf9a0f90069d5805fa7360e124f922d658d7c485811e5c9a3afe01ca7d3c

data/README.md

@@ -279,27 +279,34 @@ Documentation is generated in 2 steps:
 It's recommendable to write a few rake tasks to make things easier. Here's an example:
 
 ```ruby
-namespace :api do
-  namespace :doc do
-    desc 'Generate API documentation markdown'
-    task :json do
-      require 'rspec/core/rake_task'
-
-      RSpec::Core::RakeTask.new(:api_spec) do |t|
-        t.pattern = 'spec/controllers/api/v1/'
-        t.rspec_opts = "-f Dox::Formatter --order defined --tag dox --out public/api/docs/v1/docs.json"
-      end
+namespace :dox do
+  desc 'Generate API documentation markdown'
 
-      Rake::Task['api_spec'].invoke
-    end
+  task :json, [:version, :docs_path, :host] => :environment do |_, args|
+    require 'rspec/core/rake_task'
+    version = args[:version] || :v1
 
-    task html: :json do
-      `redoc-cli bundle -o public/api/docs/v2/index.html spec/api_doc/v1/schemas/docs.json`
+    RSpec::Core::RakeTask.new(:api_spec) do |t|
+      t.pattern = "spec/requests/api/#{version}"
+      t.rspec_opts =
+        "-f Dox::Formatter --tag dox --order defined --out spec/docs/#{version}/apispec.json"
     end
 
-    task open: :html do
-      `open public/api/docs/v1/index.html`
-    end
+    Rake::Task['api_spec'].invoke
+  end
+
+  task :html, [:version, :docs_path, :host] => :json do |_, args|
+    version = args[:version] || :v1
+    docs_path = args[:docs_path] || "api/#{version}/docs"
+
+    `yarn run redoc-cli bundle -o public/#{docs_path}/index.html spec/docs/#{version}/apispec.json`
+  end
+
+  task :open, [:version, :docs_path, :host] => :html do |_, args|
+    version = args[:version] || :v1
+    docs_path = args[:docs_path] || "api/#{version}/docs"
+
+    `open public/#{docs_path}/index.html`
   end
 end
 ```

data/lib/dox/formatters/multipart.rb

@@ -1,3 +1,5 @@
+require 'rack'
+
 module Dox
   module Formatters
     class Multipart

data/lib/dox/formatters/plain.rb

@@ -2,7 +2,11 @@ module Dox
   module Formatters
     class Plain < Dox::Formatters::Base
       def format
-        body
+        return body if body.encoding == Encoding::UTF_8
+
+        body.encode(Encoding::UTF_8)
+      rescue Encoding::UndefinedConversionError
+        "#{body.encoding} stream"
       end
     end
   end

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = '2.0.0.beta2'.freeze
+  VERSION = '2.0.0.beta3'.freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.beta3
 platform: ruby
 authors:
 - Melita Kokot
 - Vedran Hrnčić
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,7 +179,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - melita.kokot@gmail.com
 - vrabac266@gmail.com
@@ -241,7 +241,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -256,8 +256,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
 specification_version: 4
 summary: Generates API documentation for rspec in OpenAPI format.
 test_files: []