murdoc 0.1.13 → 0.2.0

data/spec/murdoc/annotator_spec.rb

@@ -8,35 +8,44 @@ describe Murdoc::Annotator do
     end
 
     it "should set source type from second argument" do
-      Murdoc::Annotator.new("# Hello", "ruby").source_type.should == "ruby"
-      Murdoc::Annotator.new("# Hello", :ruby).source_type.should == "ruby"
-    end
-
-    it "should set options from hash" do
-      Murdoc::Annotator.new("", "", :foo => :bar).options[:foo].should == :bar 
+      Murdoc::Annotator.new("# Hello", "ruby").source_type.should == :ruby
+      Murdoc::Annotator.new("# Hello", :ruby).source_type.should == :ruby
     end
   end
 
   describe ".from_file" do
-    after(:each) { FileUtils.rm "annotator_test.rb", :force => true }
+    after(:each) do
+      FileUtils.rm "annotator_test.rb", :force => true
+      FileUtils.rm "annotator_test.", :force => true
+    end
+
     it "should set #source from file contents" do
       File.open("annotator_test.rb", "w+") do |f|
         f.puts "# Comment"
         f.puts "puts 'Hello, world!'"
       end
-
       described_class.from_file("annotator_test.rb").source.should =~ /# Comment\s+puts 'Hello, world!'/
     end
 
+    it "can handle failure of non-detection" do
+      File.open('annotator_test.', 'w+')
+      described_class.from_file("annotator_test.").source_type.should == :base
+    end
+
+    it "properly detects ruby" do
+      File.open("annotator_test.rb", "w+")
+      described_class.from_file("annotator_test.rb").source_type.should == :ruby
+    end
+
     it "should detect source type from extension" do
       File.open("annotator_test.rb", "w+")
-      described_class.stub!(:detect_source_type_from_filename).and_return("test")
-      described_class.from_file("annotator_test.rb").source_type.should == "test"
+      Murdoc::Languages.stub('detect' => :test)
+      described_class.from_file("annotator_test.rb").source_type.should == :test
     end
 
     it "should still let me force source type" do
-      File.open("annotator_test.rb", "w+")      
-      described_class.from_file("annotator_test.rb", "code").source_type.should == "code"
+      File.open("annotator_test.rb", "w+")
+      described_class.from_file("annotator_test.rb", :code).source_type.should == :code
     end
   end
 
@@ -48,7 +57,7 @@ describe Murdoc::Annotator do
       let(:source) { "# Block one\n# Block one!!!!\n     def hi\nputs 'hello'\nend\n\n# Block two\ndef yo\nputs 'rap'\nend\n" }
 
       it "should split source into paragraphs" do
-        subject.should have_exactly(2).paragraphs
+        subject.paragraphs.count.should == 2
         subject.paragraphs[0].source.should =~ /\A\s*def hi\s*puts 'hello'\s*end\s*\Z/m
         subject.paragraphs[0].annotation.should =~ /\ABlock one\s*Block one!!!!\Z/m
         subject.paragraphs[1].source.should =~ /\A\s*def yo\s*puts 'rap'\s*end\s*\Z/m
@@ -56,29 +65,23 @@ describe Murdoc::Annotator do
       end
 
       it "should remove trailing comment blank line" do
-        subject.source = "# Hello\n#      \n   \n\n"
-        subject.should have_exactly(1).paragraphs
+        subject = described_class.new("# Hello\n#      \n   \n\n", :ruby)
+        subject.paragraphs.count.should == 1
         subject.paragraphs[0].annotation.should == "Hello"
       end
-
-      it "should not remove more than one space" do
-        subject.source = "#    Hello"
-        subject.should have_exactly(1).paragraphs
-        subject.paragraphs[0].annotation.should == "    Hello"
-      end      
     end
 
     context "for source with multi-line comments" do
       let(:source) { "=begin\n Block one\n Block one!!!!\n=end\n     def hi\nputs 'hello'\nend\n=begin\nBlock two\n=end\ndef yo\nputs 'rap'\nend\n" }
 
       it "should split source into paragraphs" do
-        subject.should have_exactly(2).paragraphs
+        subject.paragraphs.count.should == 2
         subject.paragraphs[0].source.should =~ /\A\s*def hi\s*puts 'hello'\s*end\s*\Z/m
         subject.paragraphs[0].annotation.should =~ /\ABlock one\s*Block one!!!!\Z/m
         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 {
@@ -90,56 +93,35 @@ describe Murdoc::Annotator do
     context "for comment without code" do
       let(:source) { "# Header\n\n\n# Comment\ndef body\nend" }
       it "should create a separate paragraph" do
-        subject.should have_exactly(2).paragraphs
+        subject.paragraphs.count.should == 2
         subject.paragraphs[0].source.should == ""
         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
-      
-      it "should not swallow wrong code" do
-        source = "# :code:\n# def hi\n# end\n\ndef hallo\nend"
-        subject = described_class.new(source, :ruby)
-        subject.should have_exactly(1).paragraphs
-        subject.paragraphs[0].annotation.to_s.should == ""
-        subject.paragraphs[0].source.should == "def hallo\nend"
-      end
-    end
 
     it "should not choke on edge cases" do
-      subject.source = ""
-      subject.source = "#"
-      subject.source = "# A\n#"
-      subject.source = "           # A\n             #            "
-      subject.source = "# A\n=begin\n"
-      subject.source = "# A\n=begin\n\n          =end yo"
-      subject.source = "# A\n=begin\n\n      asdasd    =end yo"
-      subject.source = "# A\n=begin\n\n      !!$$    =end yo"
-      subject.source = "\n            =begin\n\n          =end yo"
-      subject.source = "=begin YO =end\n\n\n\n asdasd asd"
+      expect {
+        described_class.new("", :ruby)
+        described_class.new("#", :ruby)
+        described_class.new("# A\n#", :ruby)
+        described_class.new("           # A\n             #            ", :ruby)
+        described_class.new("# A\n=begin\n", :ruby)
+        described_class.new("# A\n=begin\n\n          =end yo", :ruby)
+        described_class.new("# A\n=begin\n\n      asdasd    =end yo", :ruby)
+        described_class.new("# A\n=begin\n\n      !!$$    =end yo", :ruby)
+        described_class.new("\n            =begin\n\n          =end yo", :ruby)
+        described_class.new("=begin YO =end\n\n\n\n asdasd asd", :ruby)
+      }.not_to raise_error
     end
 
     it "should remove totally empty source" do
-      subject.source = "# Comment\n\n\n\n"
+      subject = described_class.new("# Comment\n\n\n\n", :ruby)
       subject.paragraphs[0].source.should be_empty
     end
 
     it "should remove semi-empty lines" do
-      subject.source = "def hi\n\nend"
+      subject = described_class.new("def hi\n\nend", :ruby)
       subject.paragraphs[0].source.should == "def hi\n\nend"
     end
   end
-
-
-  describe "#annotated" do
-    let(:source) { "# this" }
-    subject { described_class.new(source, :ruby) }
-  end
-end
+end

data/spec/murdoc/languages/base_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Murdoc::Languages do
+  subject { described_class }
+
+  describe '#detect' do
+    it "detects ruby files" do
+      subject.detect('hello.rb').should == :ruby
+    end
+
+    it "detects javascript files" do
+      subject.detect('hello.js').should == :js
+    end
+
+    it "detects html files" do
+      subject.detect('hello.html').should == :html
+    end
+
+    it "returns nil in case of failure" do
+      subject.detect('hello.txt').should == nil
+    end
+  end
+end

data/spec/murdoc/paragraph_spec.rb

@@ -11,15 +11,11 @@ describe Murdoc::Paragraph do
     end
 
     it "should optionally set source_type" do
-      described_class.new("", "", 0, :ruby).source_type.should == "ruby"
+      described_class.new("", "", 0, :ruby).source_type.should == :ruby
     end
 
     it "should optionally set starting line" do
       described_class.new("", "", 666, :ruby).starting_line.should == 666
     end
-
-    it "should optionally set options" do
-      described_class.new("", "", 666, :ruby, {:foo => :bar}).options.should == {:foo => :bar}
-    end
   end
-end
+end

data/spec/murdoc/{formatter_spec.rb → renderer_spec.rb}

@@ -1,6 +1,6 @@
 require "spec_helper"
 require "tempfile"
-describe Murdoc::Formatter do
+describe Murdoc::Renderer do
   describe "#initialize" do
     it "should set template from given string" do
       described_class.new("%p Hello").template.should == "%p Hello"
@@ -19,9 +19,9 @@ describe Murdoc::Formatter do
     it "should render with haml" do
       described_class.new("%p Hello").render.should =~ %r{<p>Hello</p>}
     end
-    
+
     it "should send locals to haml" do
       described_class.new("%p= foo").render(:foo => 123).should =~ %r{<p>123</p>}
     end
   end
-end
+end

data/spec/murdoc/scanner_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Murdoc::Scanner do
+  subject { described_class.new(Murdoc::Languages::Ruby) }
+
+  describe "null scanner" do
+    subject { described_class.new(Murdoc::Languages::Base) }
+
+    it "returns a single paragraph with all the text" do
+      paragraphs = subject.call("hello\nworld")
+      paragraphs.count.should == 1
+      paragraphs[0].source.should == "hello\nworld"
+      paragraphs[0].annotation.should be_empty
+    end
+  end
+
+  it "detect single line comment block annotations" do
+    # for example
+    # something like
+    # this
+
+    paragraphs = subject.call("# hello\n# hello 2\n\nworld")
+    paragraphs.count.should == 1
+    paragraphs[0].annotation.should == "hello\nhello 2"
+    paragraphs[0].source.should == 'world'
+  end
+
+  it "detects multi-line comment block annotations" do
+    # =begin
+    # this should become annotation
+    # =end
+
+    paragraphs = subject.call("=begin\nhello\n=endworld")
+    paragraphs.count.should == 1
+    paragraphs[0].annotation.should == 'hello'
+    paragraphs[0].source.should == 'world'
+  end
+
+  it "works with zero code lines" do
+    paragraphs = subject.call('# foo')
+    paragraphs.count.should == 1
+    paragraphs[0].annotation.should == 'foo'
+    paragraphs[0].source.should == ''
+  end
+
+  it "works with zero annotation lines" do
+    paragraphs = subject.call("foo bar\nbaz bool")
+    paragraphs.count.should == 1
+    paragraphs[0].source.should == "foo bar\nbaz bool"
+  end
+
+  it "works with more than one paragraph" do
+    paragraphs = subject.call("# hello\nworld\n# foo\nbar")
+    paragraphs.count.should == 2
+    paragraphs[1].annotation.should == "foo"
+    paragraphs[1].source.should == "bar"
+  end
+
+  it "removes common space prefix from multiline comment blocks" do
+    paragraphs = subject.call("=begin\n    foo\n    bar\n        baz\n=end")
+    paragraphs[0].annotation.should == "foo\nbar\n    baz"
+  end
+
+  context 'line numbers' do
+    context 'when counting normally' do
+      it "counts every line for paragraph numbering" do
+        rs = subject.call("# l1\n# l2\nl3")
+        rs[0].starting_line.should == 2
+      end
+
+      it "keeps counting empty lines" do
+        rs = subject.call("# l1\n\n\n\nl5")
+        rs[0].starting_line.should == 4
+      end
+
+      it "works with multiple paragraphs" do
+        rs = subject.call("# l1\nl2\n\n\n\n# l6\nl7")
+        rs[0].starting_line.should == 1
+        rs[1].starting_line.should == 6
+      end
+    end
+
+    context 'when ignoring comment lines' do
+      it "ignores comment lines" do
+        rs = subject.call("# l1\n# l2\nl3", true)
+        rs[0].starting_line.should == 0
+      end
+
+      it "keeps counting empty lines" do
+        rs = subject.call("# l1\n\n\n\nl5", true)
+        rs[0].starting_line.should == 3
+      end
+
+      it "works with multiple paragraphs" do
+        rs = subject.call("# l1\nl2\n\n\n\n# l6\nl7", true)
+        rs[0].starting_line.should == 0
+        rs[1].starting_line.should == 4
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,4 +2,13 @@ require "rubygems"
 require "bundler/setup"
 require "rspec"
 
-require "murdoc"
+require "murdoc"
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) {|expectations| expectations.syntax = [:should, :expect] }
+  config.mock_with(:rspec) {|mocks| mocks.syntax = :should }
+  config.raise_errors_for_deprecations!
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: murdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Abramov
@@ -14,32 +14,32 @@ dependencies:
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rdiscount
   requirement: !ruby/object:Gem::Requirement
@@ -100,35 +100,40 @@ executables:
 - murdoc
 - murdoc-strip-comments
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
 - ".document"
+- ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - UNLICENSE
-- VERSION
-- autotest/discover.rb
 - bin/murdoc
 - bin/murdoc-strip-comments
 - lib/murdoc.rb
 - lib/murdoc/annotator.rb
-- lib/murdoc/formatter.rb
+- lib/murdoc/formatted_paragraph.rb
+- lib/murdoc/languages/base.rb
+- lib/murdoc/languages/coffeescript.rb
 - lib/murdoc/languages/html.rb
 - lib/murdoc/languages/javascript.rb
+- lib/murdoc/languages/markdown.rb
 - lib/murdoc/languages/ruby.rb
 - lib/murdoc/paragraph.rb
+- lib/murdoc/renderer.rb
+- lib/murdoc/scanner.rb
+- lib/murdoc/version.rb
 - markup/stylesheet.css
 - markup/template.haml
 - markup/template_multifile.haml
 - murdoc.gemspec
 - spec/murdoc/annotator_spec.rb
-- spec/murdoc/formatter_spec.rb
+- spec/murdoc/languages/base_spec.rb
 - spec/murdoc/paragraph_spec.rb
+- spec/murdoc/renderer_spec.rb
+- spec/murdoc/scanner_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/markiz/murdoc
 licenses:
@@ -154,4 +159,10 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Annotated documentation generator
-test_files: []
+test_files:
+- spec/murdoc/annotator_spec.rb
+- spec/murdoc/languages/base_spec.rb
+- spec/murdoc/paragraph_spec.rb
+- spec/murdoc/renderer_spec.rb
+- spec/murdoc/scanner_spec.rb
+- spec/spec_helper.rb