yard 0.5.5 → 0.5.6

data/lib/yard/serializers/file_system_serializer.rb

@@ -43,7 +43,7 @@ module YARD
         objname += '_' + object.scope.to_s[0,1] if object.is_a?(CodeObjects::MethodObject)
         fspath = [objname + (extension.empty? ? '' : ".#{extension}")]
         if object.namespace && object.namespace.path != ""
-          fspath.unshift *object.namespace.path.split(CodeObjects::NSEP)
+          fspath.unshift(*object.namespace.path.split(CodeObjects::NSEP))
         end
         
         # Don't change the filenames, it just makes it more complicated

data/lib/yard/tags/default_factory.rb

@@ -85,19 +85,7 @@ module YARD
       def extract_name_from_text(text)
         text.strip.split(/\s+/, 2)
       end
-      
-      ##
-      # Extracts the type signatures and optional name from the raw tag text
-      #
-      # @param [String] text the raw tag text
-      # @return [Array] an array holding the value as the first element and
-      #                 the array of types as the second element
-      def extract_types_and_name_from_text(text)
-        text = text.strip
-        types, range, name = *parse_types(text)
-        [name, types, (range ? text[(range.end+1)..-1].strip : text)]
-      end
-      
+            
       def extract_title_and_desc_from_text(text)
         title, desc = nil, nil
         if text =~ /\A[ \t]\n/

data/lib/yard/tags/library.rb

@@ -44,7 +44,6 @@ module YARD
     class Library
       class << self
         attr_reader :labels
-        attr_accessor :default_factory
         
         def instance
           @instance ||= new
@@ -150,6 +149,9 @@ module YARD
       define_tag "Overloads",         :overload,    OverloadTag
       define_tag "Private",           :private
       define_tag "Abstract",          :abstract
+      define_tag "Attribute",         :attr,         :with_types_and_name
+      define_tag "Attribute Getter",  :attr_reader,  :with_types_and_name
+      define_tag "Attribute Setter",  :attr_writer,  :with_types_and_name
     end
   end
 end

data/lib/yard/templates/erb_cache.rb

@@ -1,11 +1,14 @@
 module YARD
   module Templates
     module ErbCache
-      def self.method_for(filename)
+      def self.method_for(filename, &block)
         @methods ||= {}
         return @methods[filename] if @methods[filename]
         @methods[filename] = name = "_erb_cache_#{@methods.size}"
-        module_eval "def #{name}; #{yield.src.gsub(/\A#coding:.*$/, '')}; end", filename
+        erb = yield.src
+        encoding = erb[/\A(#coding:.*\r?\n)/, 1] || ''
+        module_eval "#{encoding}def #{name}; #{erb}; end", filename
+        
         name
       end
 

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

@@ -73,6 +73,7 @@ module YARD
           html = fix_typewriter(html)
         end
 
+        html.force_encoding(Encoding.default_external) if RUBY19
         html = resolve_links(html)
         html = html.gsub(/<pre>(?:\s*<code>)?(.+?)(?:<\/code>\s*)?<\/pre>/m) do
           str = $1

data/lib/yard/templates/template.rb

@@ -3,7 +3,8 @@ require 'erb'
 module YARD
   module Templates
     module Template
-      attr_accessor :class, :options, :subsections, :section
+      attr_accessor :class, :section
+      attr_reader :options, :subsections
       
       class << self
         # @return [Array<Module>] a list of modules to be automatically included

data/spec/cli/yardoc_spec.rb

@@ -31,7 +31,7 @@ describe YARD::CLI::Yardoc do
   end
   
   it "should search for and use yardopts file specified by #options_file" do
-    IO.should_receive(:read).with("test").and_return("-o \n\nMYPATH\nFILE1 FILE2")
+    File.should_receive(:read_binary).with("test").and_return("-o \n\nMYPATH\nFILE1 FILE2")
     @yardoc.stub!(:support_rdoc_document_file!).and_return([])
     @yardoc.options_file = "test"
     @yardoc.run
@@ -41,15 +41,15 @@ describe YARD::CLI::Yardoc do
 
   it "should use String#shell_split to split .yardopts tokens" do
     optsdata = "foo bar"
-    optsdata.should_receive(:shell_split).and_return([optsdata])
-    IO.should_receive(:read).with("test").and_return(optsdata)
+    optsdata.should_receive(:shell_split)
+    File.should_receive(:read_binary).with("test").and_return(optsdata)
     @yardoc.stub!(:support_rdoc_document_file!).and_return([])
     @yardoc.options_file = "test"
     @yardoc.run
   end
   
   it "should allow --title to have multiple spaces in .yardopts" do
-    IO.should_receive(:read).with("test").and_return("--title \"Foo Bar\"")
+    File.should_receive(:read_binary).with("test").and_return("--title \"Foo Bar\"")
     @yardoc.stub!(:support_rdoc_document_file!).and_return([])
     @yardoc.options_file = "test"
     @yardoc.run
@@ -57,7 +57,7 @@ describe YARD::CLI::Yardoc do
   end
   
   it "should allow opts specified in command line to override yardopts file" do
-    IO.should_receive(:read).with(".yardopts").and_return("-o NOTMYPATH")
+    File.should_receive(:read_binary).with(".yardopts").and_return("-o NOTMYPATH")
     @yardoc.stub!(:support_rdoc_document_file!).and_return([])
     @yardoc.run("-o", "MYPATH", "FILE")
     @yardoc.options[:serializer].options[:basepath].should == :MYPATH
@@ -65,7 +65,7 @@ describe YARD::CLI::Yardoc do
   end
   
   it "should load the RDoc .document file if found" do
-    IO.should_receive(:read).with(".yardopts").and_return("-o NOTMYPATH")
+    File.should_receive(:read_binary).with(".yardopts").and_return("-o NOTMYPATH")
     @yardoc.stub!(:support_rdoc_document_file!).and_return(["FILE2", "FILE3"])
     @yardoc.run("-o", "MYPATH", "FILE1")
     @yardoc.options[:serializer].options[:basepath].should == :MYPATH

data/spec/handlers/class_condition_handler_spec.rb

@@ -43,4 +43,15 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassConditionHandler
   it "should only parse else block if condition is literal integer == 0" do
     verify_method :n
   end
+  
+  it "should not fail on complex conditions" do
+    lambda { YARD.parse_string("if defined?(A) && defined?(B); puts 'hi' end") }.should_not raise_error
+    lambda do 
+      YARD.parse_string(<<-eof)
+        (<<-TEST) unless defined?(ABCD_MODEL_TEST)
+          'String'
+        TEST
+      eof
+    end.should_not raise_error
+  end
 end

data/spec/handlers/class_handler_spec.rb

@@ -109,4 +109,125 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassHandler" do
   it "should not overwrite docstring with an empty one" do
     Registry.at(:Zebra).docstring.should == "Docstring 2"
   end
+  
+  it "should turn 'class Const < Struct.new(:sym)' into class Const with attr :sym" do
+    obj = Registry.at("Point")
+    obj.should be_kind_of(CodeObjects::ClassObject)
+    attrs = obj.attributes[:instance]
+    [:x, :y, :z].each do |key|
+      attrs.should have_key(key)
+      attrs[key][:read].should_not be_nil
+      attrs[key][:write].should_not be_nil
+    end
+  end
+
+  it "should turn 'class Const < Struct.new('Name', :sym)' into class Const with attr :sym" do
+    obj = Registry.at("AnotherPoint")
+    obj.should be_kind_of(CodeObjects::ClassObject)
+    attrs = obj.attributes[:instance]
+    [:a, :b, :c].each do |key|
+      attrs.should have_key(key)
+      attrs[key][:read].should_not be_nil
+      attrs[key][:write].should_not be_nil
+    end
+
+    Registry.at("XPoint").should be_nil
+  end
+  
+  it "should create a Struct::Name class when class Const < Struct.new('Name', :sym) is found" do
+    obj = Registry.at("Struct::XPoint")
+    obj.should_not be_nil
+  end
+  
+  it "should attach attribtues to the generated Struct::Name class when Struct.new('Name') is used" do
+    obj = Registry.at("Struct::XPoint")
+    attrs = obj.attributes[:instance]
+    [:a, :b, :c].each do |key|
+      attrs.should have_key(key)
+      attrs[key][:read].should_not be_nil
+      attrs[key][:write].should_not be_nil
+    end
+  end
+  
+  it "should use @attr to set attribute descriptions on Struct subclasses" do
+    obj = Registry.at("DoccedStruct#input")
+    obj.docstring.should == "the input stream"
+  end
+  
+  it "should use @attr to set attribute types on Struct subclasses" do
+    obj = Registry.at("DoccedStruct#someproc")
+    obj.should_not be_nil
+    obj.tag(:return).should_not be_nil
+    obj.tag(:return).types.should == ["Proc", "#call"]
+  end
+  
+  it "should default types unspecified by @attr to Object on Struct subclasses" do
+    obj = Registry.at("DoccedStruct#mode")
+    obj.should_not be_nil
+    obj.tag(:return).should_not be_nil
+    obj.tag(:return).types.should == ["Object"]
+  end
+  
+  it "should create parameters for writers of Struct subclass's attributes" do
+    obj = Registry.at("DoccedStruct#input=")
+    obj.tags(:param).size.should == 1
+    obj.tag(:param).types.should == ["IO"]
+  end
+  
+  it "defines both readers and writers when @attr is used on Structs" do
+    obj = Registry.at("SemiDoccedStruct")
+    attrs = obj.attributes[:instance]
+    attrs[:first][:read].should_not be_nil
+    attrs[:first][:write].should_not be_nil
+  end
+  
+  it "defines only a reader when only @attr_reader is used on Structs" do
+    obj = Registry.at("SemiDoccedStruct")
+    attrs = obj.attributes[:instance]
+    attrs[:second][:read].should_not be_nil
+    attrs[:second][:write].should be_nil
+  end
+  
+  it "defines only a writer when only @attr_writer is used on Structs" do
+    obj = Registry.at("SemiDoccedStruct")
+    attrs = obj.attributes[:instance]
+    attrs[:third][:read].should be_nil
+    attrs[:third][:write].should_not be_nil
+  end
+  
+  it "defines a reader with correct return types when @attr_reader is used on Structs" do
+    obj = Registry.at("SemiDoccedStruct#second")
+    obj.tag(:return).types.should == ["Fixnum"]
+  end
+  
+  it "defines a writer with correct parameter types when @attr_writer is used on Structs" do
+    obj = Registry.at("SemiDoccedStruct#third=")
+    obj.tag(:param).types.should == ["Array"]
+  end
+  
+  it "defines a reader and a writer when both @attr_reader and @attr_writer are used" do
+    obj = Registry.at("SemiDoccedStruct")
+    attrs = obj.attributes[:instance]
+    attrs[:fourth][:read].should_not be_nil
+    attrs[:fourth][:write].should_not be_nil
+  end
+  
+  it "uses @attr_reader for the getter when both @attr_reader and @attr_writer are given" do
+    obj = Registry.at("SemiDoccedStruct#fourth")
+    obj.tag(:return).types.should == ["#read"]
+  end
+  
+  it "uses @attr_writer for the setter when both @attr_reader and @attr_writer are given" do
+    obj = Registry.at("SemiDoccedStruct#fourth=")
+    obj.tag(:param).types.should == ["IO"]
+  end
+  
+  it "extracts text from @attr_reader" do
+    Registry.at("SemiDoccedStruct#fourth").docstring.should == "returns a proc that reads"
+  end
+  
+  it "extracts text from @attr_writer" do
+    Registry.at("SemiDoccedStruct#fourth=").docstring.should == "sets the proc that writes stuff"
+  end
+    
 end

data/spec/handlers/examples/class_handler_001.rb.txt

@@ -83,3 +83,22 @@ end
 class Zebra
 end
 
+class Point < Struct.new(:x, :y, :z)
+end
+
+class AnotherPoint < Struct.new('XPoint', :a, :b, :c, :description)
+end
+
+# @attr [IO] input the input stream
+# @attr mode the mode to read
+# @attr [Proc, #call] someproc the proc to run
+class DoccedStruct < Struct.new(:input, :mode, :someproc)
+end
+
+# @attr [String] first the first entry
+# @attr_reader [Fixnum] second this only has a reader
+# @attr_writer [Array] third this only has a writer
+# @attr_reader [#read] fourth returns a proc that reads
+# @attr_writer [IO] fourth sets the proc that writes stuff
+class SemiDoccedStruct < Struct.new(:first, :second, :third, :fourth)
+end

data/spec/parser/base_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe YARD::Parser::Base do
+  describe '#initialize' do
+    before do
+      class MyParser < Parser::Base; def initialize(a, b) end end
+    end
+    
+    it "should take 2 arguments" do
+      lambda { Parser::Base.new }.should raise_error(ArgumentError, /wrong number of arguments/)
+    end
+    
+    it "should raise NotImplementedError on #initialize" do
+      lambda { Parser::Base.new('a', 'b') }.should raise_error(NotImplementedError)
+    end
+
+    it "should raise NotImplementedError on #parse" do
+      lambda { MyParser.new('a', 'b').parse }.should raise_error(NotImplementedError)
+    end
+
+    it "should raise NotImplementedError on #tokenize" do
+      lambda { MyParser.new('a', 'b').tokenize }.should raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/parser/source_parser_spec.rb

@@ -1,10 +1,62 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
+shared_examples_for "parser type registration" do
+  before do
+    class MyParser < Parser::Base; end
+  end
+  
+  after do
+    Parser::SourceParser.parser_types.delete(:my_parser)
+    Parser::SourceParser.parser_type_extensions.delete(:my_parser)
+  end
+end
+
 describe YARD::Parser::SourceParser do
   before do 
     Registry.clear
   end
   
+  describe '.register_parser_type' do
+    it_should_behave_like "parser type registration"
+    
+    it "should register a subclass of Parser::Base" do
+      parser = mock(:parser)
+      parser.should_receive(:parse)
+      MyParser.should_receive(:new).with('content', '(stdin)').and_return(parser)
+      Parser::SourceParser.register_parser_type(:my_parser, MyParser, 'myparser')
+      Parser::SourceParser.parse_string('content', :my_parser)
+    end
+    
+    it "should require class to be a subclass of Parser::Base" do
+      lambda { Parser::SourceParser.register_parser_type(:my_parser, String) }.should raise_error(ArgumentError)
+      lambda { Parser::SourceParser.register_parser_type(:my_parser, Parser::Base) }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe '.parser_type_for_extension' do 
+    it_should_behave_like "parser type registration"
+
+    it "should find an extension in a registered array of extensions" do
+      Parser::SourceParser.register_parser_type(:my_parser, MyParser, ['a', 'b', 'd'])
+      Parser::SourceParser.parser_type_for_extension('a').should == :my_parser
+      Parser::SourceParser.parser_type_for_extension('b').should == :my_parser
+      Parser::SourceParser.parser_type_for_extension('d').should == :my_parser
+      Parser::SourceParser.parser_type_for_extension('c').should_not == :my_parser
+    end
+    
+    it "should find an extension in a Regexp" do
+      Parser::SourceParser.register_parser_type(:my_parser, MyParser, /abc$/)
+      Parser::SourceParser.parser_type_for_extension('dabc').should == :my_parser
+      Parser::SourceParser.parser_type_for_extension('dabcd').should_not == :my_parser
+    end
+    
+    it "should find an extension in a String" do
+      Parser::SourceParser.register_parser_type(:my_parser, MyParser, "abc")
+      Parser::SourceParser.parser_type_for_extension('abc').should == :my_parser
+      Parser::SourceParser.parser_type_for_extension('abcd').should_not == :my_parser
+    end
+  end
+  
   describe '#parse_string' do
     it "should parse basic Ruby code" do
       YARD.parse_string(<<-eof)
@@ -58,6 +110,17 @@ describe YARD::Parser::SourceParser do
       Registry.at('Hello2#x').docstring.should == "ANOTHER PASS"
     end
     
+    it "should take preceeding comments only if they exist" do
+      YARD.parse_string <<-eof
+        # PASS
+        module Hello # FAIL
+          HELLO
+        end
+      eof
+
+      Registry.at(:Hello).docstring.should == "PASS"
+    end
+    
     it "should handle =begin/=end style comments" do
       YARD.parse_string "=begin\nfoo\nbar\n=end\nclass Foo; end\n"
       Registry.at(:Foo).docstring.should == "foo\nbar"

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

@@ -2,7 +2,7 @@ def init
   @breadcrumb = []
 
   if @file
-    @contents = File.read_binary(@file)
+    @contents = File.read(@file)
     @file = File.basename(@file)
     @fname = @file.gsub(/\.[^.]+$/, '')
     @breadcrumb_title = "File: " + @fname

data/templates/default/tags/html/option.erb

@@ -6,7 +6,7 @@
     <ul class="option">
       <% for tag in tags %>
         <li>
-          <span class="type"><%= format_types (tag.pair.types || ['Object']) %></span>
+          <span class="type"><%= format_types(tag.pair.types || ['Object']) %></span>
           <span class="name"><%= tag.pair.name %></span>
           <span class="default">
             <% if tag.pair.defaults %>

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  version: 0.5.5
+  hash: 7
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 6
+  version: 0.5.6
 platform: ruby
 authors: 
 - Loren Segal
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-22 00:00:00 -04:00
+date: 2010-06-12 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -96,12 +102,15 @@ files:
 - lib/yard/handlers/ruby/mixin_handler.rb
 - lib/yard/handlers/ruby/module_handler.rb
 - lib/yard/handlers/ruby/process_handler.rb
+- lib/yard/handlers/ruby/struct_handler_methods.rb
 - lib/yard/handlers/ruby/visibility_handler.rb
 - lib/yard/handlers/ruby/yield_handler.rb
 - lib/yard/logging.rb
+- lib/yard/parser/base.rb
 - lib/yard/parser/c_parser.rb
 - lib/yard/parser/ruby/ast_node.rb
 - lib/yard/parser/ruby/legacy/ruby_lex.rb
+- lib/yard/parser/ruby/legacy/ruby_parser.rb
 - lib/yard/parser/ruby/legacy/statement.rb
 - lib/yard/parser/ruby/legacy/statement_list.rb
 - lib/yard/parser/ruby/legacy/token_list.rb
@@ -193,6 +202,7 @@ files:
 - spec/handlers/spec_helper.rb
 - spec/handlers/visibility_handler_spec.rb
 - spec/handlers/yield_handler_spec.rb
+- spec/parser/base_spec.rb
 - spec/parser/c_parser_spec.rb
 - spec/parser/examples/array.c.txt
 - spec/parser/examples/example1.rb.txt
@@ -378,21 +388,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: yard
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Documentation tool for consistent and usable documentation in Ruby.