lazydoc 0.3.0 → 0.3.1

data/History

@@ -0,0 +1,6 @@
+== 0.3.1 / 2009-02-17
+
+Update release with trivial changes that remove warnings under ruby 1.9
+and to accommodate JRuby 1.1.6
+
+* documents may now set default_const_name

data/lib/lazydoc.rb

@@ -24,14 +24,11 @@ module Lazydoc
     lazydoc = registry.find {|doc| doc.source_file == source_file }
     
     unless lazydoc
-      lazydoc = Document.new(source_file, default_const_name)
+      lazydoc = Document.new(source_file)
       registry << lazydoc
     end
     
-    if lazydoc.default_const_name != default_const_name
-      raise ArgumentError, "inconsistent default_const_name specified for #{source_file}: #{lazydoc.default_const_name.inspect} != #{default_const_name.inspect}"
-    end
-    
+    lazydoc.default_const_name = default_const_name
     lazydoc
   end
 

data/lib/lazydoc/comment.rb

@@ -221,14 +221,14 @@ module Lazydoc
     # As shown in the examples, the dynamically determined line_number
     # overwrites the Regexp or Proc.
     def parse_up(str, lines=nil, skip_subject=true)
-      parse(str, lines) do |n, lines|
+      parse(str, lines) do |n, comment_lines|
         # remove whitespace lines
         n -= 1 if skip_subject
-        n -= 1 while n >=0 && lines[n].strip.empty?
+        n -= 1 while n >=0 && comment_lines[n].strip.empty?
 
         # put together the comment
         while n >= 0
-          line = lines[n]
+          line = comment_lines[n]
           break if block_given? && yield(line)
           break unless prepend(line)
           n -= 1
@@ -260,12 +260,12 @@ module Lazydoc
     #   c.comment      # => "documentation for section two"
     #
     def parse_down(str, lines=nil, skip_subject=true)
-      parse(str, lines) do |n, lines|
+      parse(str, lines) do |n, comment_lines|
         # skip the subject line
         n += 1 if skip_subject
         
         # put together the comment
-        while line = lines[n]
+        while line = comment_lines[n]
           break if block_given? && yield(line)
           break unless append(line)
           n += 1

data/lib/lazydoc/document.rb

@@ -146,6 +146,15 @@ module Lazydoc
       @source_file = source_file == nil ? nil : File.expand_path(source_file)
     end
     
+    # Sets the default_const_name.  Raises an error if default_const_name is
+    # already set to a different value.
+    def default_const_name=(input)
+      @default_const_name = case @default_const_name
+      when nil, input then input
+      else raise ArgumentError, "default_const_name cannot be overridden #{source_file}: #{@default_const_name.inspect} != #{input.inspect}"
+      end
+    end
+    
     # Registers the specified line number to self.  Register may take an
     # integer or a regexp for dynamic evaluation. See Comment#resolve for
     # more details.

data/lib/lazydoc/utils.rb

@@ -85,7 +85,8 @@ module Lazydoc
       args = []
       brakets = braces = parens = 0
       start = scanner.pos
-      broke = while scanner.skip(/.*?['"#,\(\)\{\}\[\]]/)
+      broke = false
+      while scanner.skip(/.*?['"#,\(\)\{\}\[\]]/)
         pos = scanner.pos - 1
         
         case str[pos]
@@ -97,13 +98,15 @@ module Lazydoc
           args << str[start, pos-start].strip
           start = pos + 1
         
-        when ?# then break(true)                # break on a comment
+        when ?# then broke = true; break        # break on a comment
         when ?' then skip_quote(scanner, /'/)   # parse over quoted strings
         when ?" then skip_quote(scanner, /"/)   # parse over double-quoted string
           
         when ?( then parens += 1                # for brakets, braces, and parenthesis
         when ?)                                 # simply track the nesting EXCEPT for
-          break(true) if parens == 0            # RPAREN.  If the closing parenthesis
+          if parens == 0                        # RPAREN.  If the closing parenthesis
+            broke = true; break
+          end
           parens -= 1                           # is found, break.
         when ?[ then braces += 1
         when ?] then braces -= 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lazydoc
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-31 00:00:00 -07:00
+date: 2009-02-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - README
 - MIT-LICENSE
+- History
 files: 
 - lib/lazydoc.rb
 - lib/lazydoc/arguments.rb
@@ -34,6 +35,7 @@ files:
 - lib/lazydoc/utils.rb
 - README
 - MIT-LICENSE
+- History
 has_rdoc: true
 homepage: http://tap.rubyforge.org/lazydoc
 post_install_message: