Contents

module RspecApiDocumentation
  class ApiDocumentation
    attr_reader :configuration, :index

    delegate :docs_dir, :format, :to => :configuration

    def initialize(configuration)
      @configuration = configuration
      @index = Index.new
    end

    def clear_docs
      if File.exists?(docs_dir)
        FileUtils.rm_rf(docs_dir, :secure => true)
      end
      FileUtils.mkdir_p(docs_dir)
      FileUtils.cp_r(File.join(configuration.template_path, "assets"), docs_dir)
    end

    def document_example(rspec_example)
      example = Example.new(rspec_example, configuration)
      if example.should_document?
        index.examples << example
      end
    end

    def write
      writers.each do |writer|
        writer.write(index, configuration)
      end
    end

    def writers
      [*configuration.format].map do |format|
        RspecApiDocumentation.const_get("#{format}_writer".classify)
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
rspec_api_documentation-0.9.2	lib/rspec_api_documentation/api_documentation.rb
rspec_api_documentation-0.9.1	lib/rspec_api_documentation/api_documentation.rb
rspec_api_documentation-0.9.0	lib/rspec_api_documentation/api_documentation.rb
rspec_api_documentation-0.8.0	lib/rspec_api_documentation/api_documentation.rb
rspec_api_documentation-0.7.1	lib/rspec_api_documentation/api_documentation.rb
rspec_api_documentation-0.6.0	lib/rspec_api_documentation/api_documentation.rb