Class: Gem::Server

Inherits:
Object
  • Object
show all
Includes:
ERB::Util, UserInteraction
Defined in:
lib/rubygems/server.rb

Overview

Gem::Server and allows users to serve gems for consumption by `gem –remote-install`.

gem_server starts an HTTP server on the given port and serves the following:

  • “/” - Browsing of gem spec files for installed gems

  • “/specs.#marshal_version.gz” - specs name/version/platform index

  • “/latest_specs.#marshal_version.gz” - latest specs name/version/platform index

  • “/quick/” - Individual gemspecs

  • “/gems” - Direct access to download the installable gems

  • “/rdoc?q=” - Search for installed rdoc documentation

Usage

gem_server = Gem::Server.new Gem.dir, 8089, false
gem_server.run

– TODO Refactor into a real WEBrick servlet to remove code duplication.

Constant Summary collapse

SEARCH =
"<form class=\"headerSearch\" name=\"headerSearchForm\" method=\"get\" action=\"/rdoc\">\n<div id=\"search\" style=\"float:right\">\n<label for=\"q\">Filter/Search</label>\n<input id=\"q\" type=\"text\" style=\"width:10em\" name=\"q\">\n<button type=\"submit\" style=\"display:none\"></button>\n</div>\n</form>\n".freeze
DOC_TEMPLATE =
"<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n<!DOCTYPE html\nPUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n<head>\n<title>RubyGems Documentation Index</title>\n<link rel=\"stylesheet\" href=\"gem-server-rdoc-style.css\" type=\"text/css\" media=\"screen\" />\n</head>\n<body>\n<div id=\"fileHeader\">\n<%= SEARCH %>\n<h1>RubyGems Documentation Index</h1>\n</div>\n<!-- banner header -->\n\n<div id=\"bodyContent\">\n<div id=\"contextContent\">\n<div id=\"description\">\n<h1>Summary</h1>\n<p>There are <%=values[\"gem_count\"]%> gems installed:</p>\n<p>\n<%= values[\"specs\"].map { |v| \"<a href=\\\"#\#{u v[\"name\"]}\\\">\#{h v[\"name\"]}</a>\" }.join ', ' %>.\n<h1>Gems</h1>\n\n<dl>\n<% values[\"specs\"].each do |spec| %>\n<dt>\n<% if spec[\"first_name_entry\"] then %>\n<a name=\"<%=h spec[\"name\"]%>\"></a>\n<% end %>\n\n<b><%=h spec[\"name\"]%> <%=h spec[\"version\"]%></b>\n\n<% if spec[\"ri_installed\"] || spec[\"rdoc_installed\"] then %>\n<a href=\"<%=spec[\"doc_path\"]%>\">[rdoc]</a>\n<% else %>\n<span title=\"rdoc not installed\">[rdoc]</span>\n<% end %>\n\n<% if spec[\"homepage\"] then %>\n<a href=\"<%=uri_encode spec[\"homepage\"]%>\" title=\"<%=h spec[\"homepage\"]%>\">[www]</a>\n<% else %>\n<span title=\"no homepage available\">[www]</span>\n<% end %>\n\n<% if spec[\"has_deps\"] then %>\n- depends on\n<%= spec[\"dependencies\"].map { |v| \"<a href=\\\"#\#{u v[\"name\"]}\\\">\#{h v[\"name\"]}</a>\" }.join ', ' %>.\n<% end %>\n</dt>\n<dd>\n<%=spec[\"summary\"]%>\n<% if spec[\"executables\"] then %>\n<br/>\n\n<% if spec[\"only_one_executable\"] then %>\nExecutable is\n<% else %>\nExecutables are\n<%end%>\n\n<%= spec[\"executables\"].map { |v| \"<span class=\\\"context-item-name\\\">\#{h v[\"executable\"]}</span>\"}.join ', ' %>.\n\n<%end%>\n<br/>\n<br/>\n</dd>\n<% end %>\n</dl>\n\n</div>\n</div>\n</div>\n<div id=\"validator-badges\">\n<p><small><a href=\"http://validator.w3.org/check/referer\">[Validate]</a></small></p>\n</div>\n</body>\n</html>\n".freeze
RDOC_CSS =

CSS is copy & paste from rdoc-style.css, RDoc V1.0.1 - 20041108

"body {\nfont-family: Verdana,Arial,Helvetica,sans-serif;\nfont-size:   90%;\nmargin: 0;\nmargin-left: 40px;\npadding: 0;\nbackground: white;\n}\n\nh1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }\nh1 { font-size: 150%; }\nh2,h3,h4 { margin-top: 1em; }\n\na { background: #eef; color: #039; text-decoration: none; }\na:hover { background: #039; color: #eef; }\n\n/* Override the base stylesheets Anchor inside a table cell */\ntd > a {\nbackground: transparent;\ncolor: #039;\ntext-decoration: none;\n}\n\n/* and inside a section title */\n.section-title > a {\nbackground: transparent;\ncolor: #eee;\ntext-decoration: none;\n}\n\n/* === Structural elements =================================== */\n\ndiv#index {\nmargin: 0;\nmargin-left: -40px;\npadding: 0;\nfont-size: 90%;\n}\n\n\ndiv#index a {\nmargin-left: 0.7em;\n}\n\ndiv#index .section-bar {\nmargin-left: 0px;\npadding-left: 0.7em;\nbackground: #ccc;\nfont-size: small;\n}\n\n\ndiv#classHeader, div#fileHeader {\nwidth: auto;\ncolor: white;\npadding: 0.5em 1.5em 0.5em 1.5em;\nmargin: 0;\nmargin-left: -40px;\nborder-bottom: 3px solid #006;\n}\n\ndiv#classHeader a, div#fileHeader a {\nbackground: inherit;\ncolor: white;\n}\n\ndiv#classHeader td, div#fileHeader td {\nbackground: inherit;\ncolor: white;\n}\n\n\ndiv#fileHeader {\nbackground: #057;\n}\n\ndiv#classHeader {\nbackground: #048;\n}\n\n\n.class-name-in-header {\nfont-size:  180%;\nfont-weight: bold;\n}\n\n\ndiv#bodyContent {\npadding: 0 1.5em 0 1.5em;\n}\n\ndiv#description {\npadding: 0.5em 1.5em;\nbackground: #efefef;\nborder: 1px dotted #999;\n}\n\ndiv#description h1,h2,h3,h4,h5,h6 {\ncolor: #125;;\nbackground: transparent;\n}\n\ndiv#validator-badges {\ntext-align: center;\n}\ndiv#validator-badges img { border: 0; }\n\ndiv#copyright {\ncolor: #333;\nbackground: #efefef;\nfont: 0.75em sans-serif;\nmargin-top: 5em;\nmargin-bottom: 0;\npadding: 0.5em 2em;\n}\n\n\n/* === Classes =================================== */\n\ntable.header-table {\ncolor: white;\nfont-size: small;\n}\n\n.type-note {\nfont-size: small;\ncolor: #DEDEDE;\n}\n\n.xxsection-bar {\nbackground: #eee;\ncolor: #333;\npadding: 3px;\n}\n\n.section-bar {\ncolor: #333;\nborder-bottom: 1px solid #999;\nmargin-left: -20px;\n}\n\n\n.section-title {\nbackground: #79a;\ncolor: #eee;\npadding: 3px;\nmargin-top: 2em;\nmargin-left: -30px;\nborder: 1px solid #999;\n}\n\n.top-aligned-row {  vertical-align: top }\n.bottom-aligned-row { vertical-align: bottom }\n\n/* --- Context section classes ----------------------- */\n\n.context-row { }\n.context-item-name { font-family: monospace; font-weight: bold; color: black; }\n.context-item-value { font-size: small; color: #448; }\n.context-item-desc { color: #333; padding-left: 2em; }\n\n/* --- Method classes -------------------------- */\n.method-detail {\nbackground: #efefef;\npadding: 0;\nmargin-top: 0.5em;\nmargin-bottom: 1em;\nborder: 1px dotted #ccc;\n}\n.method-heading {\ncolor: black;\nbackground: #ccc;\nborder-bottom: 1px solid #666;\npadding: 0.2em 0.5em 0 0.5em;\n}\n.method-signature { color: black; background: inherit; }\n.method-name { font-weight: bold; }\n.method-args { font-style: italic; }\n.method-description { padding: 0 0.5em 0 0.5em; }\n\n/* --- Source code sections -------------------- */\n\na.source-toggle { font-size: 90%; }\ndiv.method-source-code {\nbackground: #262626;\ncolor: #ffdead;\nmargin: 1em;\npadding: 0.5em;\nborder: 1px dashed #999;\noverflow: hidden;\n}\n\ndiv.method-source-code pre { color: #ffdead; overflow: hidden; }\n\n/* --- Ruby keyword styles --------------------- */\n\n.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }\n\n.ruby-constant  { color: #7fffd4; background: transparent; }\n.ruby-keyword { color: #00ffff; background: transparent; }\n.ruby-ivar    { color: #eedd82; background: transparent; }\n.ruby-operator  { color: #00ffee; background: transparent; }\n.ruby-identifier { color: #ffdead; background: transparent; }\n.ruby-node    { color: #ffa07a; background: transparent; }\n.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }\n.ruby-regexp  { color: #ffa07a; background: transparent; }\n.ruby-value   { color: #7fffd4; background: transparent; }\n".freeze
RDOC_NO_DOCUMENTATION =
"<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n<head>\n<title>Found documentation</title>\n<link rel=\"stylesheet\" href=\"gem-server-rdoc-style.css\" type=\"text/css\" media=\"screen\" />\n</head>\n<body>\n<div id=\"fileHeader\">\n<%= SEARCH %>\n<h1>No documentation found</h1>\n</div>\n\n<div id=\"bodyContent\">\n<div id=\"contextContent\">\n<div id=\"description\">\n<p>No gems matched <%= h query.inspect %></p>\n\n<p>\nBack to <a href=\"/\">complete gem index</a>\n</p>\n\n</div>\n</div>\n</div>\n<div id=\"validator-badges\">\n<p><small><a href=\"http://validator.w3.org/check/referer\">[Validate]</a></small></p>\n</div>\n</body>\n</html>\n".freeze
RDOC_SEARCH_TEMPLATE =
"<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n<head>\n<title>Found documentation</title>\n<link rel=\"stylesheet\" href=\"gem-server-rdoc-style.css\" type=\"text/css\" media=\"screen\" />\n</head>\n<body>\n<div id=\"fileHeader\">\n<%= SEARCH %>\n<h1>Found documentation</h1>\n</div>\n<!-- banner header -->\n\n<div id=\"bodyContent\">\n<div id=\"contextContent\">\n<div id=\"description\">\n<h1>Summary</h1>\n<p><%=doc_items.length%> documentation topics found.</p>\n<h1>Topics</h1>\n\n<dl>\n<% doc_items.each do |doc_item| %>\n<dt>\n<b><%=doc_item[:name]%></b>\n<a href=\"<%=u doc_item[:url]%>\">[rdoc]</a>\n</dt>\n<dd>\n<%=h doc_item[:summary]%>\n<br/>\n<br/>\n</dd>\n<% end %>\n</dl>\n\n<p>\nBack to <a href=\"/\">complete gem index</a>\n</p>\n\n</div>\n</div>\n</div>\n<div id=\"validator-badges\">\n<p><small><a href=\"http://validator.w3.org/check/referer\">[Validate]</a></small></p>\n</div>\n</body>\n</html>\n".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose

Methods included from DefaultUserInteraction

ui, #ui, #ui=, ui=, use_ui, #use_ui

Constructor Details

#initialize(gem_dirs, port, daemon, launch = nil, addresses = nil) ⇒ Server

Returns a new instance of Server


432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/rubygems/server.rb', line 432

def initialize(gem_dirs, port, daemon, launch = nil, addresses = nil)
  Gem::RDoc.load_rdoc
  Socket.do_not_reverse_lookup = true

  @gem_dirs  = Array gem_dirs
  @port      = port
  @daemon    = daemon
  @launch    = launch
  @addresses = addresses

  logger  = WEBrick::Log.new nil, WEBrick::BasicLog::FATAL
  @server = WEBrick::HTTPServer.new :DoNotListen => true, :Logger => logger

  @spec_dirs = @gem_dirs.map { |gem_dir| File.join gem_dir, 'specifications' }
  @spec_dirs.reject! { |spec_dir| !File.directory? spec_dir }

  reset_gems

  @have_rdoc_4_plus = nil
end

Instance Attribute Details

#spec_dirsObject (readonly)

Returns the value of attribute spec_dirs


33
34
35
# File 'lib/rubygems/server.rb', line 33

def spec_dirs
  @spec_dirs
end

Class Method Details

.run(options) ⇒ Object


427
428
429
430
# File 'lib/rubygems/server.rb', line 427

def self.run(options)
  new(options[:gemdir], options[:port], options[:daemon],
      options[:launch], options[:addresses]).run
end

Instance Method Details

#add_date(res) ⇒ Object


453
454
455
456
457
# File 'lib/rubygems/server.rb', line 453

def add_date res
  res['date'] = @spec_dirs.map do |spec_dir|
    File.stat(spec_dir).mtime
  end.max
end

#doc_root(gem_name) ⇒ Object


465
466
467
468
469
470
471
# File 'lib/rubygems/server.rb', line 465

def doc_root gem_name
  if have_rdoc_4_plus? then
    "/doc_root/#{u gem_name}/"
  else
    "/doc_root/#{u gem_name}/rdoc/index.html"
  end
end

#have_rdoc_4_plus?Boolean

Returns:

  • (Boolean)

473
474
475
476
# File 'lib/rubygems/server.rb', line 473

def have_rdoc_4_plus?
  @have_rdoc_4_plus ||=
    Gem::Requirement.new('>= 4.0.0.preview2').satisfied_by? Gem::RDoc.rdoc_version
end

#latest_specs(req, res) ⇒ Object


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'lib/rubygems/server.rb', line 478

def latest_specs(req, res)
  reset_gems

  res['content-type'] = 'application/x-gzip'

  add_date res

  latest_specs = Gem::Specification.latest_specs

  specs = latest_specs.sort.map do |spec|
    platform = spec.original_platform || Gem::Platform::RUBY
    [spec.name, spec.version, platform]
  end

  specs = Marshal.dump specs

  if req.path =~ /\.gz$/ then
    specs = Gem::Util.gzip specs
    res['content-type'] = 'application/x-gzip'
  else
    res['content-type'] = 'application/octet-stream'
  end

  if req.request_method == 'HEAD' then
    res['content-length'] = specs.length
  else
    res.body << specs
  end
end

#launchObject


868
869
870
871
872
873
874
875
876
877
# File 'lib/rubygems/server.rb', line 868

def launch
  listeners = @server.listeners.map{|l| l.addr[2] }

  # TODO: 0.0.0.0 == any, not localhost.
  host = listeners.any?{|l| l == '0.0.0.0'} ? 'localhost' : listeners.first

  say "Launching browser to http://#{host}:#{@port}"

  system("#{@launch} http://#{host}:#{@port}")
end

#listen(addresses = @addresses) ⇒ Object

Creates server sockets based on the addresses option. If no addresses were given a server socket for all interfaces is created.


512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
# File 'lib/rubygems/server.rb', line 512

def listen addresses = @addresses
  addresses = [nil] unless addresses

  listeners = 0

  addresses.each do |address|
    begin
      @server.listen address, @port
      @server.listeners[listeners..-1].each do |listener|
        host, port = listener.addr.values_at 2, 1
        host = "[#{host}]" if host =~ /:/ # we don't reverse lookup
        say "Server started at http://#{host}:#{port}"
      end

      listeners = @server.listeners.length
    rescue SystemCallError
      next
    end
  end

  if @server.listeners.empty? then
    say "Unable to start a server."
    say "Check for running servers or your --bind and --port arguments"
    terminate_interaction 1
  end
end

#prerelease_specs(req, res) ⇒ Object


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
# File 'lib/rubygems/server.rb', line 539

def prerelease_specs req, res
  reset_gems

  res['content-type'] = 'application/x-gzip'

  add_date res

  specs = Gem::Specification.select do |spec|
    spec.version.prerelease?
  end.sort.map do |spec|
    platform = spec.original_platform || Gem::Platform::RUBY
    [spec.name, spec.version, platform]
  end

  specs = Marshal.dump specs

  if req.path =~ /\.gz$/ then
    specs = Gem::Util.gzip specs
    res['content-type'] = 'application/x-gzip'
  else
    res['content-type'] = 'application/octet-stream'
  end

  if req.request_method == 'HEAD' then
    res['content-length'] = specs.length
  else
    res.body << specs
  end
end

#quick(req, res) ⇒ Object


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
# File 'lib/rubygems/server.rb', line 569

def quick(req, res)
  reset_gems

  res['content-type'] = 'text/plain'
  add_date res

  case req.request_uri.path
  when %r|^/quick/(Marshal.#{Regexp.escape Gem.marshal_version}/)?(.*?)\.gemspec\.rz$| then
    marshal_format, full_name = $1, $2
    specs = Gem::Specification.find_all_by_full_name(full_name)

    selector = full_name.inspect

    if specs.empty? then
      res.status = 404
      res.body = "No gems found matching #{selector}"
    elsif specs.length > 1 then
      res.status = 500
      res.body = "Multiple gems found matching #{selector}"
    elsif marshal_format then
      res['content-type'] = 'application/x-deflate'
      res.body << Gem.deflate(Marshal.dump(specs.first))
    end
  else
    raise WEBrick::HTTPStatus::NotFound, "`#{req.path}' not found."
  end
end

#rdoc(req, res) ⇒ Object

Can be used for quick navigation to the rdoc documentation. You can then define a search shortcut for your browser. E.g. in Firefox connect 'shortcut:rdoc' to localhost:8808/rdoc?q=%s template. Then you can directly open the ActionPack documentation by typing 'rdoc actionp'. If there are multiple hits for the search term, they are presented as a list with links.

Search algorithm aims for an intuitive search:

  1. first try to find the gems and documentation folders which name starts with the search term

  2. search for entries, that contain the search term

  3. show all the gems

If there is only one search hit, user is immediately redirected to the documentation for the particular gem, otherwise a list with results is shown.

Additional trick - install documentation for Ruby core

Note: please adjust paths accordingly use for example 'locate yaml.rb' and 'gem environment' to identify directories, that are specific for your local installation

  1. install Ruby sources

    cd /usr/src
    sudo apt-get source ruby
    
  2. generate documentation

    rdoc -o /usr/lib/ruby/gems/1.8/doc/core/rdoc \
      /usr/lib/ruby/1.8 ruby1.8-1.8.7.72
    

By typing 'rdoc core' you can now access the core documentation


730
731
732
733
734
735
736
737
738
739
# File 'lib/rubygems/server.rb', line 730

def rdoc(req, res)
  query = req.query['q']
  show_rdoc_for_pattern("#{query}*", res) && return
  show_rdoc_for_pattern("*#{query}*", res) && return

  template = ERB.new RDOC_NO_DOCUMENTATION

  res['content-type'] = 'text/html'
  res.body = template.result binding
end

#reset_gemsObject

Updates the server to use the latest installed gems.


744
745
746
# File 'lib/rubygems/server.rb', line 744

def reset_gems # :nodoc:
  Gem::Specification.dirs = @gem_dirs
end

#root(req, res) ⇒ Object

Raises:

  • (WEBrick::HTTPStatus::NotFound)

597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
# File 'lib/rubygems/server.rb', line 597

def root(req, res)
  reset_gems

  add_date res

  raise WEBrick::HTTPStatus::NotFound, "`#{req.path}' not found." unless
    req.path == '/'

  specs = []
  total_file_count = 0

  Gem::Specification.each do |spec|
    total_file_count += spec.files.size
    deps = spec.dependencies.map { |dep|
      {
        "name"    => dep.name,
        "type"    => dep.type,
        "version" => dep.requirement.to_s,
      }
    }

    deps = deps.sort_by { |dep| [dep["name"].downcase, dep["version"]] }
    deps.last["is_last"] = true unless deps.empty?

    # executables
    executables = spec.executables.sort.collect { |exec| {"executable" => exec} }
    executables = nil if executables.empty?
    executables.last["is_last"] = true if executables

    # Pre-process spec homepage for safety reasons
    begin
      homepage_uri = URI.parse(spec.homepage)
      if [URI::HTTP, URI::HTTPS].member? homepage_uri.class
        homepage_uri = spec.homepage
      else
        homepage_uri = "."
      end
    rescue URI::InvalidURIError
      homepage_uri = "."
    end

    specs << {
      "authors"             => spec.authors.sort.join(", "),
      "date"                => spec.date.to_s,
      "dependencies"        => deps,
      "doc_path"            => doc_root(spec.full_name),
      "executables"         => executables,
      "only_one_executable" => (executables && executables.size == 1),
      "full_name"           => spec.full_name,
      "has_deps"            => !deps.empty?,
      "homepage"            => homepage_uri,
      "name"                => spec.name,
      "rdoc_installed"      => Gem::RDoc.new(spec).rdoc_installed?,
      "ri_installed"        => Gem::RDoc.new(spec).ri_installed?,
      "summary"             => spec.summary,
      "version"             => spec.version.to_s,
    }
  end

  specs << {
    "authors" => "Chad Fowler, Rich Kilmer, Jim Weirich, Eric Hodel and others",
    "dependencies" => [],
    "doc_path" => doc_root("rubygems-#{Gem::VERSION}"),
    "executables" => [{"executable" => 'gem', "is_last" => true}],
    "only_one_executable" => true,
    "full_name" => "rubygems-#{Gem::VERSION}",
    "has_deps" => false,
    "homepage" => "http://guides.rubygems.org/",
    "name" => 'rubygems',
    "ri_installed" => true,
    "summary" => "RubyGems itself",
    "version" => Gem::VERSION,
  }

  specs = specs.sort_by { |spec| [spec["name"].downcase, spec["version"]] }
  specs.last["is_last"] = true

  # tag all specs with first_name_entry
  last_spec = nil
  specs.each do |spec|
    is_first = last_spec.nil? || (last_spec["name"].downcase != spec["name"].downcase)
    spec["first_name_entry"] = is_first
    last_spec = spec
  end

  # create page from template
  template = ERB.new(DOC_TEMPLATE)
  res['content-type'] = 'text/html'

  values = { "gem_count" => specs.size.to_s, "specs" => specs,
             "total_file_count" => total_file_count.to_s }

  # suppress 1.9.3dev warning about unused variable
  values = values

  result = template.result binding
  res.body = result
end

#runObject


787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'lib/rubygems/server.rb', line 787

def run
  listen

  WEBrick::Daemon.start if @daemon

  @server.mount_proc "/specs.#{Gem.marshal_version}", method(:specs)
  @server.mount_proc "/specs.#{Gem.marshal_version}.gz", method(:specs)

  @server.mount_proc "/latest_specs.#{Gem.marshal_version}",
                     method(:latest_specs)
  @server.mount_proc "/latest_specs.#{Gem.marshal_version}.gz",
                     method(:latest_specs)

  @server.mount_proc "/prerelease_specs.#{Gem.marshal_version}",
                     method(:prerelease_specs)
  @server.mount_proc "/prerelease_specs.#{Gem.marshal_version}.gz",
                     method(:prerelease_specs)

  @server.mount_proc "/quick/", method(:quick)

  @server.mount_proc("/gem-server-rdoc-style.css") do |req, res|
    res['content-type'] = 'text/css'
    add_date res
    res.body << RDOC_CSS
  end

  @server.mount_proc "/", method(:root)

  @server.mount_proc "/rdoc", method(:rdoc)

  file_handlers = {
    '/gems' => '/cache/',
  }

  if have_rdoc_4_plus? then
    @server.mount '/doc_root', RDoc::Servlet, '/doc_root'
  else
    file_handlers['/doc_root'] = '/doc/'
  end

  @gem_dirs.each do |gem_dir|
    file_handlers.each do |mount_point, mount_dir|
      @server.mount(mount_point, WEBrick::HTTPServlet::FileHandler,
                    File.join(gem_dir, mount_dir), true)
    end
  end

  trap("INT") { @server.shutdown; exit! }
  trap("TERM") { @server.shutdown; exit! }

  launch if @launch

  @server.start
end

#show_rdoc_for_pattern(pattern, res) ⇒ Object

Returns true and prepares http response, if rdoc for the requested gem name pattern was found.

The search is based on the file system content, not on the gems metadata. This allows additional documentation folders like 'core' for the Ruby core documentation - just put it underneath the main doc folder.


756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'lib/rubygems/server.rb', line 756

def show_rdoc_for_pattern(pattern, res)
  found_gems = Dir.glob("{#{@gem_dirs.join ','}}/doc/#{pattern}").select {|path|
    File.exist? File.join(path, 'rdoc/index.html')
  }
  case found_gems.length
  when 0
    return false
  when 1
    new_path = File.basename(found_gems[0])
    res.status = 302
    res['Location'] = doc_root new_path
    return true
  else
    doc_items = []
    found_gems.each do |file_name|
      base_name = File.basename(file_name)
      doc_items << {
        :name    => base_name,
        :url     => doc_root(new_path),
        :summary => ''
      }
    end

    template = ERB.new(RDOC_SEARCH_TEMPLATE)
    res['content-type'] = 'text/html'
    result = template.result binding
    res.body = result
    return true
  end
end

#specs(req, res) ⇒ Object


842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
# File 'lib/rubygems/server.rb', line 842

def specs(req, res)
  reset_gems

  add_date res

  specs = Gem::Specification.sort_by(&:sort_obj).map do |spec|
    platform = spec.original_platform || Gem::Platform::RUBY
    [spec.name, spec.version, platform]
  end

  specs = Marshal.dump specs

  if req.path =~ /\.gz$/ then
    specs = Gem::Util.gzip specs
    res['content-type'] = 'application/x-gzip'
  else
    res['content-type'] = 'application/octet-stream'
  end

  if req.request_method == 'HEAD' then
    res['content-length'] = specs.length
  else
    res.body << specs
  end
end

#uri_encode(str) ⇒ Object


459
460
461
462
463
# File 'lib/rubygems/server.rb', line 459

def uri_encode(str)
  str.gsub(URI::UNSAFE) do |match|
    match.each_byte.map { |c| sprintf('%%%02X', c.ord) }.join
  end
end