dox 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4644a504fab52221669ace8661a277fc8fda67b
-  data.tar.gz: ce2eb83bea14597658c2362272d60b3615c7e936
+  metadata.gz: f6271f722c9d2fe3887a8e0732ceff6228f4f9c9
+  data.tar.gz: 8d44754eeefedee5c76d5f87ab529bb80a2ec0ab
 SHA512:
-  metadata.gz: 8ee1cbf8fda0a1a387d635898b3f65510d63bb24a892cc3c522afe7f5f4056f188afb764a0dd3682e68f53e961127c3fca43fd4f38aa7fec0048bbe6d454505a
-  data.tar.gz: 67f5c0d26c23a070fabe6e1489f439d49dbe0b4cc6da245aff2ad2ec136c8b455589f77b6049f6212f37578cd127525ad5f48b4425945e4c6275f493caa7c217
+  metadata.gz: caa994fabaa650442c1e8e669ee99bc9b32ab16b06b7387e3b2bf128bed393cb5bffb8099b20d2db71b93cfef2abac2807ba9f037ed85e654eac33187ef2a98e
+  data.tar.gz: b430db71dbfbadf6579c11da1d8a904c6914dd54b694cc24156e46f970228860fd0d33bee37aca42826bca1293687632be2c39b458bf7144a1b7abc331d83bc1

data/CHANGES.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## Version 1.1.0
+
+Released on February 19, 2018
+
+New:
+- Full RSpec failure dump to stderr if any test fails when running tests with Dox::Formatter
+- Support any payload format with pretty formatting for JSON and XML (based on `content-type` header)
+
+Fix:
+- Ignore subdomain request header in headers output
+
+
 ## Version 1.0.1
 
 Released on June 10, 2017

data/README.md

@@ -19,7 +19,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 group :test do
-  gem 'dox', require: 'false'
+  gem 'dox', require: false
 end
 ```
 
@@ -47,7 +47,7 @@ $ gem install dox
 and configure rspec with this:
 
 ``` ruby
-Rspec.configure do |config|
+RSpec.configure do |config|
   config.after(:each, :dox) do |example|
     example.metadata[:request] = request
     example.metadata[:response] = response
@@ -249,8 +249,8 @@ Documentation is generated in 2 steps:
 ```aglio -i docs.md -o docs.html```
 
 
-#### Use Rake tasks
-It's recommendable to write a few Rake tasks to make things easier. Here's an example:
+#### Use rake tasks
+It's recommendable to write a few rake tasks to make things easier. Here's an example:
 
 ```ruby
 namespace :api do

data/lib/dox/entities/action.rb

@@ -30,7 +30,8 @@ module Dox
       end
 
       def path_params
-        @path_params ||= request.path_parameters.symbolize_keys.except(:action, :controller, :format)
+        @path_params ||=
+          request.path_parameters.symbolize_keys.except(:action, :controller, :format, :subdomain)
       end
 
       def template_path_params

data/lib/dox/entities/example.rb

@@ -16,7 +16,7 @@ module Dox
       end
 
       def request_body
-        @request_body ||= parse_request_body
+        @request_body ||= request.body.read
       end
 
       def request_identifier
@@ -44,7 +44,7 @@ module Dox
 
       # Rails 5.0.2 returns "" for request.path
       def request_path
-        request.path.presence || request.fullpath.split("?")[0]
+        request.path.presence || request.fullpath.split('?')[0]
       end
 
       attr_reader :desc, :request, :response
@@ -65,12 +65,6 @@ module Dox
       def request_url_query_parameters
         CGI.unescape(request.query_parameters.to_query)
       end
-
-      def parse_request_body
-        body = request.body.read
-        return body if body.blank?
-        JSON.parse(body)
-      end
     end
   end
 end

data/lib/dox/formatter.rb

@@ -1,11 +1,12 @@
 require 'rspec/core'
 require 'rspec/core/formatters/base_formatter'
+require 'rspec/core/formatters/console_codes'
 
 module Dox
   class Formatter < RSpec::Core::Formatters::BaseFormatter
     extend Forwardable
 
-    RSpec::Core::Formatters.register self, :example_passed, :stop
+    RSpec::Core::Formatters.register self, :example_passed, :stop, :dump_summary
 
     def initialize(output)
       super
@@ -17,8 +18,18 @@ module Dox
       move_example_to_passed if current_example.document?
     end
 
-    def stop(_notification)
-      printer.print(passed_examples)
+    def stop(notification)
+      if notification.failed_examples.any?
+        $stderr.puts(notification.fully_formatted_failed_examples)
+      else
+        printer.print(passed_examples)
+      end
+    end
+
+    def dump_summary(summary)
+      return if summary.failed_examples.none?
+      $stderr.puts(summary.fully_formatted)
+      exit(-1)
     end
 
     private

data/lib/dox/printers/example_printer.rb

@@ -1,3 +1,5 @@
+require 'rexml/document'
+
 module Dox
   module Printers
     class ExamplePrinter < BasePrinter
@@ -52,7 +54,7 @@ module Dox
 
     + Body
 
-#{indent_lines(12, pretty_json(example.request_body))}
+#{indent_lines(12, formatted_body(example.request_body, example.request_content_type))}
         HEREDOC
       end
 
@@ -77,10 +79,21 @@ module Dox
 
     + Body
 
-#{indent_lines(12, pretty_json(safe_json_parse(example.response_body)))}
+#{indent_lines(12, formatted_body(example.response_body, example.response_content_type))}
         HEREDOC
       end
 
+      def formatted_body(body_str, content_type)
+        case content_type
+        when %r{application\/.*json}
+          pretty_json(safe_json_parse(body_str))
+        when /xml/
+          pretty_xml(body_str)
+        else
+          body_str
+        end
+      end
+
       def safe_json_parse(json_string)
         json_string.length >= 2 ? JSON.parse(json_string) : nil
       end
@@ -93,6 +106,15 @@ module Dox
         end
       end
 
+      def pretty_xml(xml_string)
+        doc = REXML::Document.new(xml_string)
+        formatter = REXML::Formatters::Pretty.new
+        formatter.compact = true
+        result = ''
+        formatter.write(doc, result)
+        result
+      end
+
       def print_headers(headers)
         headers.map do |key, value|
           "#{key}: #{value}"

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Melita Kokot
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-10 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler