Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 3a4854adda
Fetching contributors…

Cannot retrieve contributors at this time

file 416 lines (323 sloc) 6.312 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
# -*- encoding: utf-8 -*-

require "stringio"
require "tempfile"

require "rdoc"
require "rdoc/parser/sinatra"

require "minitest/autorun"


class TestRDocParserSinatra < MiniTest::Unit::TestCase

  def setup
    @tempfile = Tempfile.new self.class.name
    @filename = @tempfile.path

    RDoc::TopLevel.reset
    @top_level = RDoc::TopLevel.new @filename

    @options = RDoc::Options.new
    @options.quiet = true
    @stats = RDoc::Stats.new 0

    @route_definitions = @routes = nil
  end

  def teardown
    @tempfile.close
  end



  def test_routes_stored_in_top_level_application_routes_class_hiding_in_modules
    app = <<-APP
require "sinatra"

##
# Route 1
#
get "/foo" do
:hi
end
APP

    make_a_parser_for app
    @parser.scan

    r = RDoc::TopLevel.find_module_named "Application Routes"
    r.wont_be_nil

    r.method_list.first.name.must_equal 'GET "/foo"'
  end

  def test_route_presented_as_http_method_and_route_pattern
    app = <<-APP
require "sinatra"

##
# Route 2
#
# Some more text goes here.
#
get "/foo" do
:hi
end
APP

    make_a_parser_for app
    extract_routes
    
    r = @routes.first

    r.name.must_equal 'GET "/foo"'
    r.comment.text.must_equal "Route 2\n\nSome more text goes here."
  end

  def test_route_pattern_may_be_regexp
    app = <<-APP
require "sinatra"

##
# Route 3
#
get /foo/ do
:hi
end

##
# Route 4
#
get %r{bar} do
:ho
end
APP

    make_a_parser_for app
    extract_routes
    
    @routes.size.must_equal 2

    r = @routes.first
    r.name.must_equal 'GET /foo/'
    r.comment.text.must_equal "Route 3"

    r = @routes.last
    r.name.must_equal 'GET %r{bar}'
    r.comment.text.must_equal "Route 4"
  end


  %w[GET HEAD POST PUT PATCH DELETE OPTIONS].each {|http|
    define_method("test_parses_#{http}_definition") {
      make_a_parser_for define_all_the_things!
      extract_routes

      @routes.find {|r| r.name.include? http }.wont_be_nil
    }
  }

  def test_parses_error_definitions_without_status_code_defaulting_to_500
    app = <<-APP
require "sinatra"

##
# Gettersy
#
get "foo" do
:hi
end

##
# OMG ERROR
#
error do
:haha
end
APP

    make_a_parser_for app
    extract_routes
    
    @routes.size.must_equal 2

    r = @routes.last
    r.name.must_equal "error 500"
  end

  def test_parses_error_definitions_with_status_codes
    app = <<-APP
require "sinatra"

##
# Getters
#
get "foo" do
:hi
end

##
# Fourohthree
#
error 403 do
:haha
end
APP

    make_a_parser_for app
    extract_routes
    
    @routes.size.must_equal 2

    r = @routes.last
    r.name.must_equal "error 403"
  end

  def test_parses_not_found_definition_into_a_404_error
    app = <<-APP
require "sinatra"

##
# Route 5
#
get "foo" do
:hi
end

##
# Route 6
#
not_found do
:haha
end
APP

    make_a_parser_for app
    extract_routes
    
    @routes.size.must_equal 2

    r = @routes.last
    r.name.must_equal "error 404"
  end

  def test_parses_same_route_pattern_with_different_methods_as_separate
    app = <<-APP
require "sinatra"

##
# Route 7
#
get "foo" do
:hi
end

##
# Route 8
#
put "foo" do
:ho
end
APP

    make_a_parser_for app
    extract_routes
    
    @routes.size.must_equal 2

    r = @routes.first
    r.name.must_equal 'GET "foo"'

    r = @routes.last
    r.name.must_equal 'PUT "foo"'
  end

  def test_parses_same_route_pattern_with_same_method_as_the_same_and_latter_overrides
    app = <<-APP
require "sinatra"

##
# Initial definition
#
get "foo" do
:hi
end

##
# YAY OVERRIDE
#
get "foo" do
:ho
end
APP

    make_a_parser_for app
    extract_routes
    
    @routes.size.must_equal 1

    r = @routes.first
    r.name.must_equal 'GET "foo"'
    r.comment.text.must_equal "YAY OVERRIDE"
  end

# May end up not doing this at all.
# def test_get_definitions_automatically_add_a_head_definition_with_same_comment
# flunk
# end

  def test_allows_normal_ruby_docs_to_be_mixed_in_same_doc
    app = <<-APP
require "sinatra"

##
# Route def
#
get "foo" do
:hi
end

#
# Random method
#
def foo; end

#
# Random class
#
class Yay

##
# Random metamethod
#
some_meta :metafoo

#
# Random method in a class
#
def yayfoo; end
end
APP

    make_a_parser_for app
    extract_routes

    @routes.size.must_equal 1

    o = RDoc::TopLevel.find_class_named "Object"
    o.method_list.first.name.must_equal "foo"

    y = RDoc::TopLevel.find_class_named "Yay"
    y.method_list.size.must_equal 2

    y.method_list.shift.name.must_equal "metafoo"
    y.method_list.shift.name.must_equal "yayfoo"
  end

  def test_parses_route_inside_a_class_definition
    app = <<-APP
require "sinatra"

class Yay < Sinatra::Base
##
# Route 9
#
get "foo" do
:hi
end
end
APP

    make_a_parser_for app
    extract_routes
    
    @routes.size.must_equal 1

    r = @routes.first
    r.name.must_equal 'GET "foo"'
  end

# def test_parses_route_inside_a_sinatra_base_inheriting_class_only
# flunk
# end
#
# def test_parses_route_inside_a_base_class_into_that_class_not_application_routes
# flunk
# end


  private

  def make_a_parser_for(content)
    @parser = RDoc::Parser::Sinatra.new @top_level, @filename, content, @options, @stats
  end

  def extract_routes
    @parser.scan
    @route_definitions = RDoc::TopLevel.find_module_named "Application Routes"
    @routes = @route_definitions.method_list
  end

  def define_all_the_things!
    <<-END
require "sinatra"

##
# GET route
#
get "/foo" do
"hi"
end

##
# HEAD route
#
head "/bar" do
"ho"
end

##
# POST route
#
post "/foo/:id" do
:yay
end

##
# PUT route
#
put "/foo/:id" do
:yay
end

##
# DELETE route
#
delete %r{hi there} do
:ugg
end

##
# PATCH route
#
patch /foo^bar/ do
:mug
end

##
# OPTIONS route
#
options "foo/" do
:whatevs
end
END
  end
end
Something went wrong with that request. Please try again.