Module: DocMyRoutes

Defined in:
lib/doc_my_routes.rb,
lib/doc_my_routes/version.rb,
lib/doc_my_routes/doc/route.rb,
lib/doc_my_routes/doc/config.rb,
lib/doc_my_routes/doc/errors.rb,
lib/doc_my_routes/doc/mapping.rb,
lib/doc_my_routes/doc/documentation.rb,
lib/doc_my_routes/doc/examples_handler.rb,
lib/doc_my_routes/doc/route_collection.rb,
lib/doc_my_routes/doc/status_code_info.rb,
lib/doc_my_routes/doc/mixins/annotatable.rb,
lib/doc_my_routes/doc/route_documentation.rb

Overview

Define error classes

Defined Under Namespace

Modules: Annotatable, StatusCodeInfo Classes: Config, Documentation, ExampleMissing, ExamplesHandler, Mapping, MultipleMappingDetected, Route, RouteCollection, RouteDocumentation, UnsupportedError

Constant Summary collapse

VERSION = 
'0.10.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.



12
13
14
 
# File 'lib/doc_my_routes.rb', line 12

def config
  @config
end

.logger ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/doc_my_routes.rb', line 14

def logger
  @logger ||= begin
    require 'logger'
    Logger.new($stdout).tap do |log|
      log.progname = name
    end
  end
end

Class Method Details

.configure {|config| ... } ⇒ Object

Nothing fancy here, just gem configuration inspired by many gems e.g., robots.thoughtbot.com/mygem-configure-block

Yields:



8
9
10
11
 
# File 'lib/doc_my_routes/doc/config.rb', line 8

def configure
  self.config ||= Config.new
  yield(config)
end