zipmark/rspec_api_documentation

View on GitHub
lib/rspec_api_documentation/dsl.rb

Summary

Maintainability
A
0 mins
Test Coverage
require "rspec_api_documentation"
require "rspec_api_documentation/dsl/resource"
require "rspec_api_documentation/dsl/endpoint"
require "rspec_api_documentation/dsl/callback"


module RspecApiDocumentation
  module DSL

    # Custom describe block that sets metadata to enable the rest of RAD
    #
    #   resource "Orders", :meta => :data do
    #     # ...
    #   end
    #
    # Params:
    # +args+:: Glob of RSpec's `describe` arguments
    # +block+:: Block to pass into describe
    #
    def resource(*args, &block)
      options = args.last.is_a?(Hash) ? args.pop : {}
      options[:api_doc_dsl] = :resource
      options[:resource_name] = args.first.to_s
      options[:document] = :all unless options.key?(:document)
      args.push(options)
      describe(*args, &block)
    end
  end
end

RSpec::Core::ExampleGroup.extend(RspecApiDocumentation::DSL)
RSpec::Core::DSL.expose_example_group_alias(:resource)

RSpec.configuration.include RspecApiDocumentation::DSL::Resource, :api_doc_dsl => :resource
RSpec.configuration.include RspecApiDocumentation::DSL::Endpoint, :api_doc_dsl => :endpoint
RSpec.configuration.include RspecApiDocumentation::DSL::Callback, :api_doc_dsl => :callback
RSpec.configuration.backtrace_exclusion_patterns << %r{lib/rspec_api_documentation/dsl/}

if defined? RSpec::Rails::DIRECTORY_MAPPINGS
  RSpec::Rails::DIRECTORY_MAPPINGS[:acceptance] = %w[spec acceptance]
  RSpec.configuration.infer_spec_type_from_file_location!
end