rspec-api-docs 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 921c43cbac7e32c779901db4a5519ad6b5fefbc0
-  data.tar.gz: 68cb6ae49fbf805cb4786ef8494a9466693ea143
+  metadata.gz: 7d10d8bca800c45005afc8f8d95a1f5373885cb6
+  data.tar.gz: 9f88eb3855beceebd31c878a3be6887c6cfc63d5
 SHA512:
-  metadata.gz: 97c817ca345c1a021d701fea14a7881ff58f6b57f283ae413067287ff0b0dc7ebc46b9e8fd08761c79f84437b9a4e071b4a02a5f4154178740df3d064fec50ca
-  data.tar.gz: f3ce3df2074ed3032314b78d2c1ec6cdd27f8fccbf31cee4431f98032662bfba8b693cdd8408496de1b3e155e7b082bdbc85de4750e5cdaae66ab63e80fec004
+  metadata.gz: fec38ab112edb6805a565d7f220c427c66d77499429e61a4ffb3e689a99fc25e3c73edce2113faabc2d437f8fb175c121154865a623ea338706e15a37a844250
+  data.tar.gz: 79aa77d8356314ac968ab9a9ca9064e0a5f95f0572b5f45a48013e9d07e727dca3fa1e06d52f6706a41d29134b4bc01eeac7cc579d945633bfc8689720f115bd

data/.rubocop.yml

@@ -6,16 +6,13 @@ AllCops:
 Metrics/LineLength:
   Max: 120
 
-Metrics/AbcSize:
-  Enabled: true
-
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: leading
 
-Style/AlignHash:
+Layout/AlignHash:
   Enabled: true
 
-Style/ExtraSpacing:
+Layout/ExtraSpacing:
   AllowForAlignment: false
 
 Style/HashSyntax:
@@ -33,10 +30,10 @@ Style/PercentLiteralDelimiters:
     '%W': '[]'
     '%x': '[]'
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
-Style/SpaceInsideBlockBraces:
+Layout/SpaceInsideBlockBraces:
   EnforcedStyleForEmptyBraces: space
 
 Style/StringLiterals:
@@ -51,5 +48,5 @@ Style/TrailingCommaInArguments:
 Style/ClassAndModuleChildren:
   EnforcedStyle: nested
 
-Style/MultilineOperationIndentation:
+Layout/MultilineOperationIndentation:
   EnforcedStyle: indented

data/lib/rspec_api_docs/dsl/doc_proxy.rb

@@ -146,6 +146,41 @@ module RspecApiDocs
       def precedence(value)
         metadata[METADATA_NAMESPACE][:example_precedence] = value
       end
+
+      # For passing a lambda to modify the response body
+      #
+      # This is useful if the entire body of the response isn't relevant to the
+      # documentation example.
+      #
+      # With a response body of:
+      #
+      #     {
+      #       characters: [
+      #         {
+      #           id: 1,
+      #           name: 'Finn The Human',
+      #         },
+      #         {
+      #           id: 2,
+      #           name: 'Jake The Dog',
+      #         },
+      #       ],
+      #     }
+      #
+      # Usage:
+      #
+      #     doc do
+      #       response_body_after_hook -> (parsed_response_body) {
+      #         parsed_response_body[:characters].delete_if { |character| character[:id] != 1 }
+      #         parsed_response_body
+      #       }
+      #     end
+      #
+      # @param value [Lambda] after hook lambda
+      # @return [void]
+      def response_body_after_hook(value)
+        metadata[METADATA_NAMESPACE][:response_body_after_hook] = value
+      end
     end
   end
 end

data/lib/rspec_api_docs/formatter/resource/example.rb

@@ -130,6 +130,9 @@ module RspecApiDocs
               DeepHashSet.call(parsed_body, f.scope + [f.name], f.example)
             end
           end
+          if metadata[:response_body_after_hook]
+            parsed_body = metadata[:response_body_after_hook].call(parsed_body)
+          end
           JSON.dump(parsed_body)
         end
       end

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-docs
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Odin Dutton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler