rspec-api-docs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e9892448884eff6e7ab9f869c5358595e25af95
-  data.tar.gz: 11968fb9bb7a942b6859c8f13029ab37765c936c
+  metadata.gz: e7e5799e512fca99e136a0909ba2118a90d96073
+  data.tar.gz: 48de8b3f91fa45947fc1903fe25b0e4b8351aa93
 SHA512:
-  metadata.gz: 0dd30dcf52b5df54ba6ac7179e315619bec8f6652679291fcc12ff0a974d98b184ca97b61da3e6eda8dabed7abd420c4814f32edc86d0fcec00d7441803497dc
-  data.tar.gz: f313600b62164dfae76b321187860fb894eed9c8b6732249c060418c7daa6c8072fbc22b590dbaf9f4ed13b2a8ea44fcde1ffcf7bbd8dcdeb01d29bc428cac97
+  metadata.gz: adac7650aa8fbd77ae177ec13eb55173818a0c48cf725795bbc0fa8821a98c7e9b375cc3418b0df1b668cd508cdad26c83b39e578c1ba76d2400235cbc7478e5
+  data.tar.gz: 12f01cf8d991c15c98b5d05b9a452f0ea2e915049160337b8ef5ef39510b356af4ece8d43096aa80cdb2935e564f4394ca06599269c3fd5115e0efdac551f74f

data/README.md

@@ -207,6 +207,18 @@ param :id, 'The id of a character', scope: :character, type: 'integer', required
 param :name, "The character's name", scope: :character, type: 'string'
 ```
 
+#### `notes`
+
+Accepts a `note` and optional `level`.
+
+- `level` [`Symbol`] one of `:success`, `:info`, `:warning`, or `:danger`. Defaults to `:info`
+- `note` [`String`] the note
+
+``` ruby
+note 'You need to supply an id!'
+note :warning, "An error will be thrown if you don't supply an id!"
+```
+
 See the integration specs for more examples of the DSL in use.
 
 ### Formatter

data/Rakefile

@@ -10,4 +10,9 @@ RuboCop::RakeTask.new :rubocop do |task|
   task.verbose = false
 end
 
-task default: [:rspec, :rubocop]
+task :generate_integration_docs do
+  system './bin/generate_integration_docs'
+  exit $?.exitstatus
+end
+
+task default: [:rspec, :rubocop, :generate_integration_docs]

data/bin/generate_integration_docs

@@ -1,4 +1,6 @@
-#!/usr/bin/env bash -ex
+#!/usr/bin/env bash
+
+set -ex
 
 rm -rf spec/integration/output
 

data/lib/rspec_api_docs.rb

@@ -1,6 +1,7 @@
 require 'rspec_api_docs/config'
 require 'rspec_api_docs/version'
 
+# The base module of the gem.
 module RspecApiDocs
   METADATA_NAMESPACE = :rspec_api_docs
 

data/lib/rspec_api_docs/config.rb

@@ -12,6 +12,7 @@ module RspecApiDocs
     yield configuration
   end
 
+  # Used to control the behaviour of the gem.
   class Config
     attr_accessor \
       :output_dir,

data/lib/rspec_api_docs/dsl/doc_proxy.rb

@@ -1,6 +1,8 @@
 module RspecApiDocs
   module Dsl
     class DocProxy
+      UnknownNoteLevel = Class.new(BaseError)
+
       attr_reader :metadata
 
       def initialize(example)
@@ -112,6 +114,18 @@ module RspecApiDocs
           required: required,
         }
       end
+
+      # For setting notes on an example
+      #
+      # @param level [Symbol] the level of the note
+      # @param value [String] the note, +:success+, +:info+, +:warning+, or +:danger+
+      # @return [void]
+      def note(level = :info, value)
+        %i[success info warning danger].include?(level) or
+          raise UnknownNoteLevel, "unknown note level #{level.inspect}"
+        metadata[METADATA_NAMESPACE][:note] ||= {}
+        metadata[METADATA_NAMESPACE][:note][level] = value
+      end
     end
   end
 end

data/lib/rspec_api_docs/formatter/renderer/json_renderer/example_serializer.rb

@@ -17,6 +17,7 @@ module RspecApiDocs
             path: example.path,
             requests: example.requests,
             response_fields: response_fields,
+            notes: example.notes,
           }
         end
 

data/lib/rspec_api_docs/formatter/renderer/raddocs_renderer/resource_serializer.rb

@@ -33,7 +33,7 @@ module RspecApiDocs
           parameters.map do |parameter|
             result = {}
             result[:required] = true if parameter.required
-            result[:scope] = parameter.scope
+            result[:scope] = parameter.scope.join
             result = result.merge(
               name: parameter.name,
               description: parameter.description,
@@ -45,7 +45,7 @@ module RspecApiDocs
         def response_fields(fields)
           fields.map do |field|
             {
-              scope: field.scope,
+              scope: field.scope.join,
               Type: field.type,
               name: field.name,
               description: field.description,

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

@@ -82,6 +82,11 @@ module RspecApiDocs
         request_response_pairs.first.first.request_method
       end
 
+      # @return [Hash<Symbol,String>, nil]
+      def notes
+        metadata.fetch(:note, {})
+      end
+
       private
 
       def request_response_pairs

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

@@ -10,9 +10,9 @@ module RspecApiDocs
 
       # The scope of the parameter
       #
-      # @return [String]
+      # @return [Array<String>]
       def scope
-        parameter[:scope].join
+        parameter[:scope]
       end
 
       # If the parameter is required

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

@@ -10,9 +10,9 @@ module RspecApiDocs
 
       # The scope of the response field
       #
-      # @return [String]
+      # @return [Array<String>]
       def scope
-        field[:scope].join
+        field[:scope]
       end
 
       # The type of the response field

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-docs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Odin Dutton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-01 00:00:00.000000000 Z
+date: 2017-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler