Contents

require 'rspec/core/formatters/base_formatter'

require 'rspec_api_docs'
require 'rspec_api_docs/resource_collection'
require 'rspec_api_docs/formatter/resource'
require 'rspec_api_docs/formatter/renderer/json_renderer'
require 'rspec_api_docs/formatter/renderer/raddocs_renderer'
require 'rspec_api_docs/formatter/renderer/slate_renderer'

module RspecApiDocs
  # Unknown renderer configured.
  UnknownRenderer = Class.new(BaseError)

  # The RSpec formatter.
  #
  # Usage:
  #
  #     rspec --format=RspecApiDocs::Formatter
  class Formatter < RSpec::Core::Formatters::BaseFormatter
    RSpec::Core::Formatters.register self, :example_passed, :close

    attr_reader :renderer

    def initialize(*args, renderer: default_renderer)
      @renderer = renderer
      super args
    end

    # Initializes and stores {Resource}s.
    #
    # @return [void]
    def example_passed(example_notification)
      rspec_example = example_notification.example
      return unless rspec_example.metadata[METADATA_NAMESPACE]
      resource_collection.add_example(rspec_example)
    end

    # Calls the configured renderer with the stored {Resource}s.
    #
    # @return [void]
    def close(null_notification)
      renderer.new(resource_collection.all).render
    end

    private

    def resource_collection
      @resource_collection ||= ResourceCollection.new
    end

    def default_renderer
      value = RspecApiDocs.configuration.renderer

      case value
      when :json
        Renderer::JSONRenderer
      when :raddocs
        Renderer::RaddocsRenderer
      when :slate
        Renderer::SlateRenderer
      when Class
        value
      else
        raise UnknownRenderer, "unknown renderer #{value.inspect}"
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
rspec-api-docs-1.1.0	lib/rspec_api_docs/formatter.rb
rspec-api-docs-1.0.0	lib/rspec_api_docs/formatter.rb
rspec-api-docs-0.14.0	lib/rspec_api_docs/formatter.rb
rspec-api-docs-0.13.0	lib/rspec_api_docs/formatter.rb
rspec-api-docs-0.12.0	lib/rspec_api_docs/formatter.rb
rspec-api-docs-0.11.0	lib/rspec_api_docs/formatter.rb
rspec-api-docs-0.10.0	lib/rspec_api_docs/formatter.rb