yard 0.8.2.1 → 0.8.3

data/spec/rubygems/doc_manager_spec.rb

@@ -11,7 +11,7 @@ describe Gem::DocManager do
 
     YARD::CLI::Yardoc.stub(:run)
 
-    @spec_file = File.join(YARD::ROOT, '../yard.gemspec')
+    @spec_file = File.join(YARD::ROOT, '..', 'yard.gemspec')
     @spec = Gem::SourceIndex.load_specification(@spec_file)
     @spec.has_yardoc = false # no yardoc docs for now
     @yardopts = File.join(@spec.full_gem_path, '.yardopts')

data/spec/server/commands/static_file_command_spec.rb

@@ -24,10 +24,10 @@ describe YARD::Server::Commands::StaticFileCommand do
     end
 
     it "should return file contents if found" do
-      path = File.join(StaticFileCommand::STATIC_PATHS.last, '/path/to/file.txt')
+      tpl = Templates::Engine.template(:default, :fulldoc, :html)
       File.should_receive(:exist?).with('/c/path/to/file.txt').and_return(false)
-      File.should_receive(:exist?).with(path).and_return(true)
-      File.should_receive(:read).with(path).and_return('FOO')
+      tpl.should_receive(:find_file).with('/path/to/file.txt').and_return('/path/to/foo')
+      File.should_receive(:read).with('/path/to/foo').and_return('FOO')
       run('/path/to/file.txt', 200, 'FOO')
     end
 

data/spec/spec_helper.rb

@@ -5,6 +5,25 @@ rescue LoadError
   require "spec"
 end
 
+begin
+  require 'bundler'
+  Bundler.setup
+rescue LoadError
+end
+
+begin
+  require 'simplecov'
+  SimpleCov.start
+  # TODO: hide some rb files from cov report
+  # hide = '_spec\.rb$,spec_helper\.rb$,ruby_lex\.rb$,autoload\.rb$'
+  # if YARD::Parser::SourceParser.parser_type == :ruby
+  #   hide += ',legacy\/.+_handler'
+  # else
+  #   hide += ',ruby_parser\.rb$,ast_node\.rb$,handlers\/ruby\/[^\/]+\.rb$'
+  # end
+rescue LoadError
+end if ENV['COVERAGE']
+
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'yard'))
 
 unless defined?(HAVE_RIPPER)
@@ -33,7 +52,7 @@ def described_in_docs(klass, meth, file = nil)
   else
     underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
     $".find_all {|p| p.include? underscore }.each do |filename|
-      next unless File.exists? filename
+      next unless File.exist? filename
       YARD::Parser::SourceParser.new.parse(filename)
     end
   end
@@ -65,7 +84,7 @@ def docspec(objname = self.class.description, klass = self.class.described_type)
   underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
   $".find_all {|p| p.include? underscore }.each do |filename|
     filename = File.join(YARD::ROOT, filename)
-    next unless File.exists? filename
+    next unless File.exist? filename
     YARD::Parser::SourceParser.new.parse(filename)
   end
 
@@ -96,7 +115,7 @@ module Kernel
     args.first
   end
 
-  def puts(str)
+  def puts(str = '')
     STDOUT.puts str + "<br/>\n"
     str
   end

data/spec/templates/helpers/html_helper_spec.rb

@@ -22,14 +22,14 @@ describe YARD::Templates::Helpers::HtmlHelper do
 
   describe '#charset' do
     it "should return foo if LANG=foo" do
-      ENV.should_receive(:[]).with('LANG').and_return('shift_jis') if RUBY18
+      ENV.should_receive(:[]).with('LANG').and_return('shift_jis') if YARD.ruby18?
       Encoding.default_external.should_receive(:name).and_return('shift_jis') if defined?(Encoding)
       charset.should == 'shift_jis'
     end
 
     ['US-ASCII', 'ASCII-7BIT', 'ASCII-8BIT'].each do |type|
       it "should convert #{type} to iso-8859-1" do
-        ENV.should_receive(:[]).with('LANG').and_return(type) if RUBY18
+        ENV.should_receive(:[]).with('LANG').and_return(type) if YARD.ruby18?
         Encoding.default_external.should_receive(:name).and_return(type) if defined?(Encoding)
         charset.should == 'iso-8859-1'
       end
@@ -37,7 +37,7 @@ describe YARD::Templates::Helpers::HtmlHelper do
 
     it "should support utf8 as an encoding value for utf-8" do
       type = 'utf8'
-      ENV.should_receive(:[]).with('LANG').and_return(type) if RUBY18
+      ENV.should_receive(:[]).with('LANG').and_return(type) if YARD.ruby18?
       Encoding.default_external.should_receive(:name).and_return(type) if defined?(Encoding)
       charset.should == 'utf-8'
     end
@@ -46,15 +46,15 @@ describe YARD::Templates::Helpers::HtmlHelper do
       @file = OpenStruct.new(:contents => 'foo'.force_encoding('sjis'))
       # not the correct charset name, but good enough
       ['Shift_JIS', 'Windows-31J'].should include(charset)
-    end if RUBY19
+    end if YARD.ruby19?
 
     it "should take file encoding if there is a file" do
-      ENV.stub!(:[]).with('LANG').and_return('utf-8') if RUBY18
+      ENV.stub!(:[]).with('LANG').and_return('utf-8') if YARD.ruby18?
       @file = OpenStruct.new(:contents => 'foo')
       charset.should == 'utf-8'
-    end if RUBY18
+    end if YARD.ruby18?
 
-    if RUBY18
+    if YARD.ruby18?
       it "should return utf-8 if no LANG env is set" do
         ENV.should_receive(:[]).with('LANG').and_return(nil)
         charset.should == 'utf-8'
@@ -145,7 +145,9 @@ describe YARD::Templates::Helpers::HtmlHelper do
 
     it "should autolink URLs (markdown specific)" do
       log.enter_level(Logger::FATAL) do
-        pending 'This test depends on markdown' unless markup_class(:markdown)
+        unless markup_class(:markdown).to_s == "RedcarpetCompat"
+          pending 'This test depends on a markdown engine that supports autolinking'
+        end
       end
       htmlify('http://example.com', :markdown).chomp.gsub('/', '/').should ==
         '<p><a href="http://example.com">http://example.com</a></p>'

data/templates/default/fulldoc/html/frames.erb

@@ -3,7 +3,7 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+	<meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>"/>
 	<title><%= options.title %></title>
 </head>
 <script type="text/javascript" charset="utf-8">

data/templates/default/fulldoc/html/setup.rb

@@ -186,7 +186,7 @@ def class_list(root = Registry.root)
   children.reject {|c| c.nil? }.sort_by {|child| child.path }.map do |child|
     if child.is_a?(CodeObjects::NamespaceObject)
       name = child.namespace.is_a?(CodeObjects::Proxy) ? child.path : child.name
-      has_children = child.children.any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
+      has_children = run_verifier(child.children).any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
       out << "<li>"
       out << "<a class='toggle'></a> " if has_children
       out << linkify(child, name)

data/yard.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/yard/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "yard"
+  s.summary       = "Documentation tool for consistent and usable documentation in Ruby."
+  s.description   = <<-eof
+    YARD is a documentation generation tool for the Ruby programming language.
+    It enables the user to generate consistent, usable documentation that can be
+    exported to a number of formats very easily, and also supports extending for
+    custom Ruby constructs such as custom class level definitions.
+  eof
+  s.version       = YARD::VERSION
+  s.date          = Time.now.strftime('%Y-%m-%d')
+  s.author        = "Loren Segal"
+  s.email         = "lsegal@soen.ca"
+  s.homepage      = "http://yardoc.org"
+  s.platform      = Gem::Platform::RUBY
+  s.files         = Dir.glob("{docs,bin,lib,spec,templates,benchmarks}/**/*") +
+    ['ChangeLog', 'LICENSE', 'LEGAL', 'README.md', 'Rakefile', '.yardopts', __FILE__]
+  s.require_paths = ['lib']
+  s.executables   = ['yard', 'yardoc', 'yri']
+  s.has_rdoc      = 'yard'
+  s.rubyforge_project = 'yard'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.2.1
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-10 00:00:00.000000000 -04:00
-default_executable: 
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies: []
 description: ! "    YARD is a documentation generation tool for the Ruby programming
   language.\n    It enables the user to generate consistent, usable documentation
@@ -62,6 +61,7 @@ files:
 - lib/yard/cli/server.rb
 - lib/yard/cli/stats.rb
 - lib/yard/cli/yardoc.rb
+- lib/yard/cli/yardopts_command.rb
 - lib/yard/cli/yri.rb
 - lib/yard/code_objects/base.rb
 - lib/yard/code_objects/class_object.rb
@@ -236,6 +236,7 @@ files:
 - lib/yard/templates/template.rb
 - lib/yard/templates/template_options.rb
 - lib/yard/verifier.rb
+- lib/yard/version.rb
 - lib/yard.rb
 - spec/cli/command_parser_spec.rb
 - spec/cli/command_spec.rb
@@ -566,7 +567,7 @@ files:
 - README.md
 - Rakefile
 - .yardopts
-has_rdoc: yard
+- yard.gemspec
 homepage: http://yardoc.org
 licenses: []
 post_install_message: 
@@ -587,8 +588,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: yard
-rubygems_version: 1.3.9.5
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Documentation tool for consistent and usable documentation in Ruby.
 test_files: []
+has_rdoc: yard