yard 0.6.1 → 0.6.2

data/lib/yard/parser/source_parser.rb

@@ -1,5 +1,8 @@
 require 'stringio'
-require 'continuation' unless RUBY18
+
+begin
+  require 'continuation'
+rescue LoadError; end
 
 module YARD
   module Parser
@@ -236,7 +239,7 @@ module YARD
       # @since 0.5.3
       def convert_encoding(content)
         return content if RUBY18
-        if content =~ /\A\s*#.*coding[:=]\s*(\S+)\s*$/
+        if content =~ /\A(?:\s*#*!.*\r?\n)?\s*#+.*coding\s*[:=]{1,2}\s*(\S+)/i
           content.force_encoding($1)
         else
           content

data/lib/yard/serializers/yardoc_serializer.rb

@@ -16,7 +16,7 @@ module YARD
     
     def method_missing(meth, *args, &block)
       return true if meth == :respond_to? && args.first == :_dump
-      return Registry.at(@path).send(meth, *args, &block) if @transient
+      @object = nil if @transient
       @object ||= Registry.at(@path)
       @object.send(meth, *args, &block)
     rescue NoMethodError => e
@@ -84,7 +84,7 @@ module YARD
       def internal_dump(object, first_object = false)
         if !first_object && object.is_a?(CodeObjects::Base) && 
             !(Tags::OverloadTag === object)
-          return StubProxy.new(object.path, true)
+          return StubProxy.new(object.path)
         end
         
         if object.is_a?(Hash) || object.is_a?(Array) || 

data/lib/yard/server.rb

@@ -0,0 +1,11 @@
+module YARD
+  module Server
+    # Registers a static path to be used in static asset lookup.
+    # @param [String] path the pathname to register
+    # @return [void]
+    # @since 0.6.2
+    def self.register_static_path(path)
+      Commands::StaticFileCommand::STATIC_PATHS.push(path)
+    end
+  end
+end

data/lib/yard/server/commands/frames_command.rb

@@ -5,7 +5,7 @@ module YARD
         include DocServerHelper
         
         def run
-          main_url = request.path.gsub(/^(.+)?\/frames\/(#{path})$/, '\1/\2')
+          main_url = request.path.gsub(/^(.+)?\/frames(?:\/(#{path}))?$/, '\1/\2')
           if path =~ %r{^file/}
             page_title = "File: #{$'}"
           elsif !path.empty?

data/lib/yard/server/commands/library_command.rb

@@ -16,6 +16,10 @@ module YARD
         
         # @return [Boolean] whether to reparse data 
         attr_accessor :incremental
+
+        # Needed to synchronize threads in {#setup_yardopts}
+        # @private
+        @@library_chdir_lock = Mutex.new
         
         def initialize(opts = {})
           super
@@ -23,6 +27,7 @@ module YARD
         end
 
         def call(request)
+          self.request = request
           self.options = SymbolHash.new(false).update(
             :serialize => false,
             :serializer => serializer,
@@ -35,32 +40,36 @@ module YARD
           setup_library
           super
         rescue LibraryNotPreparedError
-          not_prepared(request)
+          not_prepared
         end
 
         private
 
         def setup_library
-          library.prepare!
+          library.prepare! if request.xhr? && request.query['process']
           load_yardoc
           setup_yardopts
           true
         end
 
         def setup_yardopts
-          Dir.chdir(library.source_path)
-          yardoc = CLI::Yardoc.new
-          if incremental
-            yardoc.run('-c', '-n', '--no-stats')
-          else
-            yardoc.parse_arguments
+          @@library_chdir_lock.synchronize do
+            Dir.chdir(library.source_path) do
+              yardoc = CLI::Yardoc.new
+              if incremental
+                yardoc.run('-c', '-n', '--no-stats')
+              else
+                yardoc.parse_arguments
+              end
+              yardoc.options.delete(:serializer)
+              yardoc.options[:files].unshift(*Dir.glob('README*'))
+              options.update(yardoc.options.to_hash)
+            end
           end
-          yardoc.options.delete(:serializer)
-          yardoc.options[:files].unshift(*Dir.glob(library.source_path + '/README*'))
-          options.update(yardoc.options.to_hash)
         end
 
         def load_yardoc
+          raise LibraryNotPreparedError unless library.yardoc_file
           if @@last_yardoc == library.yardoc_file
             log.debug "Reusing yardoc file: #{library.yardoc_file}"
             return
@@ -70,7 +79,7 @@ module YARD
           @@last_yardoc = library.yardoc_file
         end
         
-        def not_prepared(request)
+        def not_prepared
           self.caching = false
           options.update(:path => request.path, :template => :doc_server, :type => :processing)
           [302, {'Content-Type' => 'text/html'}, [render]]
@@ -80,4 +89,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/server/commands/library_index_command.rb

@@ -1,6 +1,7 @@
 module YARD
   module Server
     module Commands
+      # Returns the index of libraries served by the server.
       class LibraryIndexCommand < Base
         attr_accessor :options
         

data/lib/yard/server/commands/search_command.rb

@@ -1,6 +1,8 @@
 module YARD
   module Server
     module Commands
+      # Performs a search over the objects inside of a library and returns
+      # the results as HTML or plaintext
       class SearchCommand < LibraryCommand
         attr_accessor :results, :query
         

data/lib/yard/server/commands/static_file_command.rb

@@ -3,11 +3,16 @@ require 'webrick/httputils'
 module YARD
   module Server
     module Commands
+      # Serves static content when no other router matches a request
       class StaticFileCommand < Base
         include WEBrick::HTTPUtils
 
         DefaultMimeTypes['js'] = 'text/javascript'
 
+        # Defines the paths used to search for static assets. To define an
+        # extra path, use {YARD::Server.register_static_path} rather than
+        # modifying this constant directly. Also note that files in the
+        # document root will always take precedence over these paths.
         STATIC_PATHS = [
           File.join(YARD::TEMPLATE_ROOT, 'default', 'fulldoc', 'html'),
           File.join(File.dirname(__FILE__), '..', 'templates', 'default', 'fulldoc', 'html')
@@ -15,7 +20,7 @@ module YARD
         
         def run
           path = File.cleanpath(request.path).gsub(%r{^(../)+}, '')
-          ([adapter.document_root] + STATIC_PATHS).compact.each do |path_prefix|
+          ([adapter.document_root] + STATIC_PATHS.reverse).compact.each do |path_prefix|
             file = File.join(path_prefix, path)
             if File.exist?(file)
               ext = "." + (request.path[/\.(\w+)$/, 1] || "html")

data/lib/yard/server/templates/doc_server/processing/html/processing.erb

@@ -7,8 +7,8 @@
     <link rel="stylesheet" href="/css/custom.css" type="text/css" media="screen" charset="utf-8" />
     <script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
     <script type="text/javascript" charset="utf-8">
-      function checkPage() {
-        $.ajax({cache: false, url: "<%= @path %>", success: function() { window.location = "<%= @path %>"; } });
+      function checkPage(process) {
+        $.ajax({cache: false, url: "<%= @path %>" + (process ? "?process=true" : ""), success: function() { window.location = "<%= @path %>"; } });
         setTimeout('checkPage()', 2000);
       }
       function setFade() {
@@ -23,7 +23,7 @@
         $('#processing').css('left', ($(window).width() / 2 - $('#processing').width() / 2) + 'px');
         $('#processing').css('top', ($(window).height() / 2 - $('#processing').height() / 2) + 'px');
       }
-      $(checkPage);
+      $(function() { checkPage(true); });
       $(setFade);
     </script>
     <style type="text/css" media="screen">

data/lib/yard/templates/helpers/html_helper.rb

@@ -51,7 +51,7 @@ module YARD
           str = $1
           str = html_syntax_highlight(CGI.unescapeHTML(str)) unless options[:no_highlight]
           %Q{<pre class="code">#{str}</pre>}
-        end
+        end unless markup == :text
         html
       end
       

data/lib/yard/templates/helpers/markup_helper.rb

@@ -9,7 +9,8 @@ module YARD
           {:lib => :bluecloth, :const => 'BlueCloth'},
           {:lib => :maruku, :const => 'Maruku'},
           {:lib => :"rpeg-markdown", :const => "PEGMarkdown"},
-          {:lib => :rdiscount, :const => "RDiscount"}
+          {:lib => :rdiscount, :const => "RDiscount"},
+          {:lib => :kramdown, :const => "Kramdown::Document"}
         ],
         :textile => [
           {:lib => :redcloth, :const => 'RedCloth'}
@@ -47,8 +48,6 @@ module YARD
         require 'rdoc/markup/simple_markup/to_html'
         SimpleMarkup = SM::SimpleMarkup.new
       end
-
-      private
       
       # Attempts to load the first valid markup provider in {MARKUP_PROVIDERS}.
       # If a provider is specified, immediately try to load it.
@@ -59,34 +58,36 @@ module YARD
       # 
       # On failure this method will inform the user that no provider could be
       # found and exit the program.
+      # 
+      # @return [Boolean] whether the markup provider was successfully loaded.
       def load_markup_provider(type = options[:markup])
-        return if type == :rdoc || (@markup_cache && @markup_cache[type])
+        return true if type == :rdoc || (@markup_cache && @markup_cache[type])
         @markup_cache ||= {}
         @markup_cache[type] ||= {}
         
         providers = MARKUP_PROVIDERS[type]
-        return if providers && providers.empty?
-        if options[:markup_provider]
+        return true if providers && providers.empty?
+        if providers && options[:markup_provider]
           providers = providers.select {|p| p[:lib] == options[:markup_provider] }
         end
         
         if providers == nil || providers.empty?
-          STDERR.puts "Invalid markup type '#{type}'"
-          exit
+          log.error "Invalid markup type '#{type}' or markup provider is not registered."
+          return false
         end
         
         # Search for provider, return the library class name as const if found
         providers.each do |provider|
           begin require provider[:lib].to_s; rescue LoadError; next end
           @markup_cache[type][:provider] = provider[:lib] # Cache the provider
-          @markup_cache[type][:class] = Kernel.const_get(provider[:const])
-          return
+          @markup_cache[type][:class] = eval(provider[:const])
+          return false
         end
         
         # Show error message telling user to install first potential provider
         name, lib = providers.first[:const], providers.first[:lib]
-        STDERR.puts "Missing #{name} gem for #{options[:markup].to_s.capitalize} formatting. Install it with `gem install #{lib}`"
-        exit
+        log.error "Missing #{name} gem for #{options[:markup].to_s.capitalize} formatting. Install it with `gem install #{lib}`"
+        false
       end
       
       # Checks for a shebang or looks at the file extension to determine

data/lib/yard/verifier.rb

@@ -67,11 +67,13 @@ module YARD
       end
     end
 
-    # Tests the expressions on the object
+    # Tests the expressions on the object.
     # 
+    # @note If the object is a {CodeObjects::Proxy} the result will always be true.
     # @param [CodeObjects::Base] object the object to verify
     # @return [Boolean] the result of the expressions
     def call(object)
+      return true if object.is_a?(CodeObjects::Proxy)
       modify_nilclass
       @object = object
       retval = __execute ? true : false

data/spec/cli/config_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YARD::CLI::Config do
+  before do
+    @config = YARD::CLI::Config.new
+    YARD::Config.options = YARD::Config::DEFAULT_CONFIG_OPTIONS.dup
+    YARD::Config.stub!(:save)
+  end
+  
+  def run(*args)
+    @config.run(*args)
+  end
+  
+  describe 'Listing configuration' do
+    it "should accept --list" do
+      opts = YARD::Config.options
+      YAML.should_receive(:dump).twice.and_return("--- foo\nbar\nbaz")
+      @config.should_receive(:puts).twice.with("bar\nbaz")
+      run
+      run('--list')
+      YARD::Config.options.should == opts
+    end
+  end
+  
+  describe 'Viewing an item' do
+    it "should view item if no value is given" do
+      YARD::Config.options[:foo] = 'bar'
+      @config.should_receive(:puts).with('"bar"')
+      run 'foo'
+      YARD::Config.options[:foo].should == 'bar'
+    end
+  end
+  
+  describe 'Modifying an item' do
+    it "should accept --reset to set value" do
+      YARD::Config.options[:load_plugins] = 'foo'
+      run('--reset', 'load_plugins')
+      YARD::Config.options[:load_plugins].should == false
+    end
+    
+    
+    it "should modify item if value is given" do
+      run('foo', 'xxx')
+      YARD::Config.options[:foo].should == 'xxx'
+    end
+    
+    it "should turn list of values into array of values" do
+      run('foo', 'a', 'b', '1', 'true', 'false')
+      YARD::Config.options[:foo].should == ['a', 'b', 1, true, false]
+    end
+    
+    it "should turn number into numeric Ruby type" do
+      run('foo', '1')
+      YARD::Config.options[:foo].should == 1
+    end
+    
+    it "should turn true into TrueClass" do
+      run('foo', 'true')
+      YARD::Config.options[:foo].should == true
+    end
+    
+    it "should turn false into FalseClass" do
+      run('foo', 'false')
+      YARD::Config.options[:foo].should == false
+    end
+    
+    it "should save on modification" do
+      YARD::Config.should_receive(:save)
+      run('foo', 'true')
+    end
+  end
+end

data/spec/cli/gems_spec.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'ostruct'
+require 'rubygems'
+
+describe YARD::CLI::Gems do
+  before do
+    @rebuild = false
+    @gem1 = build_mock('gem1')
+    @gem2 = build_mock('gem2')
+    @gem3 = build_mock('gem3')
+  end
+  
+  def build_mock(name, version = '1.0')
+    OpenStruct.new  :name => name, 
+                    :version => version, 
+                    :full_gem_path => "/path/to/gems/#{name}-#{version}", 
+                    :yardoc_file => "/path/to/yardoc/#{name}-#{version}"
+  end
+  
+  def build_specs(*specs)
+    specs.each do |themock|
+      Registry.should_receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}").and_return(themock.yardoc_file)
+      File.should_receive(:directory?).with(themock.yardoc_file).and_return(@rebuild)
+      File.should_receive(:directory?).with(themock.full_gem_path).and_return(true)
+      Registry.should_receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}", true).and_return(themock.yardoc_file)
+      Dir.should_receive(:chdir).with(themock.full_gem_path)
+    end
+    Registry.should_receive(:clear).exactly(specs.size).times
+    CLI::Yardoc.should_receive(:run).exactly(specs.size).times
+  end
+  
+  describe '#run' do
+    it "should build all gem indexes if no gem is specified" do
+      build_specs(@gem1, @gem2)
+      Gem.source_index.should_receive(:find_name).with('').and_return([@gem1, @gem2])
+      CLI::Gems.run
+    end
+    
+    it "should allow gem to be specified" do
+      build_specs(@gem1)
+      Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 0').and_return([@gem1])
+      CLI::Gems.run(@gem1.name)
+    end
+    
+    it "should allow multiple gems to be specified for building" do
+      build_specs(@gem1, @gem2)
+      Gem.source_index.should_receive(:find_name).with(@gem1.name, @gem1.version).and_return([@gem1])
+      Gem.source_index.should_receive(:find_name).with(@gem2.name, '>= 0').and_return([@gem2])
+      CLI::Gems.run(@gem1.name, @gem1.version, @gem2.name)
+    end
+    
+    it "should allow version to be specified with gem" do
+      build_specs(@gem1)
+      Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
+      CLI::Gems.run(@gem1.name, '>= 1.0')
+    end
+    
+    it "should warn if one of the gems is not found, but it should process others" do
+      build_specs(@gem2)
+      Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
+      Gem.source_index.should_receive(:find_name).with(@gem2.name, '>= 0').and_return([@gem2])
+      log.should_receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
+      CLI::Gems.run(@gem1.name, '>= 2.0', @gem2.name)
+    end
+    
+    it "should fail if specified gem(s) is/are not found" do
+      CLI::Yardoc.should_not_receive(:run)
+      Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
+      log.should_receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
+      log.should_receive(:error).with(/No specified gems could be found/)
+      CLI::Gems.run(@gem1.name, '>= 2.0')
+    end
+    
+    it "should accept --rebuild" do
+      @rebuild = true
+      build_specs(@gem1)
+      Gem.source_index.should_receive(:find_name).with('').and_return([@gem1])
+      CLI::Gems.run('--rebuild')
+    end
+  end
+end