murdoc 0.1.6 → 0.1.7

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/lib/murdoc/annotator.rb

@@ -47,25 +47,9 @@ module Murdoc
     def source=(src)
       @source = src
       @paragraphs = []
-
-      # Lambda for checking source for comments. Used for getting consequent non-comments
-      # into resulting stream
-      is_comment = lambda do |line|
-        result = false
-        # If source supports single line comments
-        if comment_symbols[:single_line]
-          result ||= line =~ /^\s*#{Regexp.escape(comment_symbols[:single_line])}/
-        end
-
-        # If source supports multi-line comments
-        if comment_symbols[:multiline]
-          result ||= line =~ /^\s*#{Regexp.escape(comment_symbols[:multiline][:begin])}/
-        end
-        result
-      end
+      lines = src.split("\n")
 
       # splitting stuff into lines and setting cursor into initial position
-      lines = src.split("\n")
       i = 0
       while i < lines.size
         comment_lines = []
@@ -93,22 +77,19 @@ module Murdoc
         # getting source lines
         starting_line = i
         source_lines = []
-        while i < lines.size && !is_comment.call(lines[i])
+        while i < lines.size && !is_comment(lines[i])
           source_lines << lines[i]
           i += 1
         end
+
         # post-processing: stripping comments and removing empty strings from beginnings and ends
-        while source_lines.size > 0 && source_lines[0] =~ /^\s*$/
-          starting_line += 1
-          source_lines.delete_at(0)
+        starting_line += postprocess_source(source_lines)
+        postprocess_comments(comment_lines)
+        
+        # writing a new paragraph unless we have a case of commented out code
+        unless comment_lines[0] =~ /^:code:$/
+          @paragraphs << Paragraph.new(source_lines.join("\n"), comment_lines.join("\n"), starting_line, source_type, options)
         end
-        source_lines.delete_at(-1) while source_lines.size > 0 && source_lines[-1] =~ /^\s*$/
-        comment_lines.map! {|l| l.sub(/^\s([^\s])/, '\\1').rstrip }
-        comment_lines.delete_at(0) while comment_lines.size > 0 && comment_lines[0].empty?
-        comment_lines.delete_at(-1) while comment_lines.size > 0 && comment_lines[-1].empty?
-
-        # writing a new paragraph
-        @paragraphs << Paragraph.new(source_lines.join("\n"), comment_lines.join("\n"), starting_line, source_type, options)
       end
     end
 
@@ -116,10 +97,52 @@ module Murdoc
     def source
       @source
     end
-
+    
   protected
     def comment_symbols
       super || {}
     end
+
+    # Method for checking source for comments. Used for getting consequent non-comments
+    # into resulting stream
+    def is_comment(line)
+      result = false
+      # If source supports single line comments
+      if comment_symbols[:single_line]
+        result ||= line =~ /^\s*#{Regexp.escape(comment_symbols[:single_line])}/
+      end
+
+      # If source supports multi-line comments
+      if comment_symbols[:multiline]
+        result ||= line =~ /^\s*#{Regexp.escape(comment_symbols[:multiline][:begin])}/
+      end
+      result
+    end
+
+    #
+    # Removes trailing spaces from comments, also removes first space from comments,
+    # but only if there's only one space there (not to mess with markdown)
+    #
+    def postprocess_comments(comment_lines)
+      comment_lines.map! {|l| l.sub(/^\s([^\s])/, '\\1').rstrip }
+      comment_lines.delete_at(0) while comment_lines.size > 0 && comment_lines[0].empty?
+      comment_lines.delete_at(-1) while comment_lines.size > 0 && comment_lines[-1].empty?
+    end
+
+    
+    # Removes blank lines from beginning and end of source lines
+    # returns starting offset for source (number of lines deleted from beginning)
+    def postprocess_source(source_lines)
+      starting_offset = 0
+      while source_lines.size > 0 && source_lines[0] =~ /^\s*$/
+        starting_offset += 1
+        source_lines.delete_at(0)
+      end
+      
+      while source_lines.size > 0 && source_lines[-1] =~ /^\s*$/
+        source_lines.delete_at(-1) 
+      end
+      starting_offset
+    end
   end
 end

data/murdoc.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{murdoc}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Abramov"]
-  s.date = %q{2011-01-25}
+  s.date = %q{2011-01-27}
   s.default_executable = %q{murdoc}
   s.description = %q{Annotated documentation generator, see README.md for details}
   s.email = %q{markizko@gmail.com}

data/spec/murdoc/annotator_spec.rb

@@ -78,6 +78,14 @@ describe Murdoc::Annotator do
         subject.paragraphs[1].source.should =~ /\A\s*def yo\s*puts 'rap'\s*end\s*\Z/m
         subject.paragraphs[1].annotation.should =~ /\ABlock two\Z/m
       end
+      
+      it "should not hang upon non-closed comments" do
+        source = "=begin\n"
+        lambda {
+          subject = described_class.new(source, :ruby)
+          subject.source = source
+        }.should_not raise_error
+      end
     end
 
     context "for comment without code" do
@@ -88,6 +96,15 @@ describe Murdoc::Annotator do
         subject.paragraphs[0].annotation.should == "Header"
       end
     end
+    
+    context "for commented code" do
+      let(:source) { "# :code:\n# def hello\n# end\n\n\# Comment\ndef hi\nend" }
+      it "should not create paragraphs" do
+        subject.should have_exactly(1).paragraphs
+        subject.paragraphs[0].source.should == "def hi\nend"
+        subject.paragraphs[0].annotation.should == "Comment"
+      end
+    end
 
     it "should not choke on edge cases" do
       subject.source = ""

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Mark Abramov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 +03:00
+date: 2011-01-27 00:00:00 +03:00
 default_executable: murdoc
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -151,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2317771152433802766
+      hash: -231788783804928032
       segments: 
       - 0
       version: "0"