murdoc 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+UNLICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--autotest
+--colour

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem "jeweler"
+gem "rspec", "~> 2.1.0"
+gem "rdiscount", "~> 1.6.5"
+gem "haml", "~> 3.0.0"
+gem "sass", "~> 3.1.0"

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    haml (3.0.24)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rdiscount (1.6.5)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    sass (3.1.0.alpha.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  haml (~> 3.0.0)
+  jeweler
+  rdiscount (~> 1.6.5)
+  rspec (~> 2.1.0)
+  sass (~> 3.1.0)

data/README.md

@@ -0,0 +1,19 @@
+Murdoc -- evil ruby documenter
+==============================
+
+Murdoc is a doccu-style annotated documentation generator.
+
+You may also want to see:
+
+* [docco.coffee](http://jashkenas.github.com/docco/)
+* [Rocco](http://rtomayko.github.com/rocco/)
+
+Example
+=======
+
+See example at [GH.pages](http://markiz.github.com/murdoc).
+
+License and authorship
+======================
+
+Murdoc is originally authored by Mark Abramov and belongs to public domain (see UNLICENSE for details).

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "murdoc"
+  gem.homepage = "http://github.com/markiz/murdoc"
+  gem.license = "Public Domain"
+  gem.summary = "Annotated documentation generator"
+  gem.description = "Annotated documentation generator, see README.md for details"
+  gem.email = "markizko@gmail.com"
+  gem.authors = ["Mark Abramov"]
+  gem.add_runtime_dependency "haml", "~> 3.0.0"
+  gem.add_runtime_dependency "rdiscount", "~> 1.6.5"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "murdoc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/bin/murdoc

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require "optparse"
+$: << "./lib/"
+require "murdoc"
+
+
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "murdoc <input file> <output html>"  
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+end
+
+option_parser.parse!
+
+if ARGV.size < 2
+  puts option_parser
+else
+  Murdoc.generate_from_file(ARGV[0], ARGV[1])
+end

data/lib/murdoc.rb

@@ -0,0 +1,25 @@
+#
+# Murdoc is *yet another* Doccu-like documentation generator.
+# Murdoc reads ruby source files and produces annotated html documentation.
+#
+# See also: [Docco][do], [Rocco][ro]
+#
+# [do]: "http://jashkenas.github.com/docco/"
+# [ro]: "http://rtomayko.github.com/rocco"
+#
+
+
+module Murdoc
+  def self.generate_from_file(input, output)
+    annotator = Annotator.from_file(input)
+    File.open(output, "w+") do |f|
+      f.puts Formatter.new("markup/template.haml").render(:paragraphs => annotator.paragraphs, :stylesheet => File.read("markup/stylesheet.css"))
+    end
+  end
+end
+
+require "murdoc/annotator"
+require "murdoc/paragraph"
+require "murdoc/formatter"
+
+Dir["#{File.dirname(File.expand_path(__FILE__))}/murdoc/languages/*.rb"].each {|lang| require lang }

data/lib/murdoc/annotator.rb

@@ -0,0 +1,112 @@
+# Annotator class does all the main job: parses out comments
+# and returns annotated code
+
+
+# Main module
+module Murdoc
+  class Annotator
+    # Attribute accessor containing the resulting paragraphs
+    attr_accessor :paragraphs
+
+
+    # `source` string contains annotated source code
+    # `source_type` is one of supported source types (currently `[:ruby, :javascript]`)
+    def initialize(source, source_type)
+      self.source_type = source_type
+      self.source      = source
+    end
+
+    # You may also initialize annotator from file, it will even try to detect the
+    # source type from extension.
+    def self.from_file(filename, source_type = nil)
+      self.new(File.read(filename), source_type || detect_source_type_from_filename(filename))
+    end
+
+    def source_type
+      @source_type
+    end
+
+    def source_type=(source_type)
+      @source_type = source_type.to_s
+    end
+
+    # Big and hairy code parser
+    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
+
+      # splitting stuff into lines and setting cursor into initial position
+      lines = src.split("\n")
+      i = 0
+      while i < lines.size
+        comment_lines = []
+        # get single line comments (removing optional first space after comment symbol)
+        if comment_symbols[:single_line]
+          while i < lines.size && lines[i] =~ /^\s*#{Regexp.escape(comment_symbols[:single_line])}\s?(.*)/
+            comment_lines << $1
+            i += 1
+          end
+        end
+
+        # getting multiline comments
+        if comment_symbols[:multiline]
+          begin_symbol = Regexp.escape(comment_symbols[:multiline][:begin])
+          end_symbol = Regexp.escape(comment_symbols[:multiline][:end])
+          if i < lines.size && lines[i] =~ /\s*#{begin_symbol}/
+            begin
+              match = lines[i].match /\s*(#{begin_symbol})?\s?(.*?)(#{end_symbol}|$)/
+              comment_lines << match[2]
+              i += 1
+            end while i < lines.size && !(lines[i-1] =~ /\s*#{end_symbol}/)
+          end
+        end
+
+        # getting source lines
+        starting_line = i
+        source_lines = []
+        while i < lines.size && !is_comment.call(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)
+        end
+        source_lines.delete_at(-1) while source_lines.size > 0 && source_lines[-1] =~ /^\s*$/
+        comment_lines.map! {|l| l.strip }
+        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)
+      end
+    end
+
+    # Rest of the file quite less self-explanatory
+    def source
+      @source
+    end
+
+  protected
+    def comment_symbols
+      super || {}
+    end
+  end
+end

data/lib/murdoc/formatter.rb

@@ -0,0 +1,19 @@
+require "haml"
+
+module Murdoc
+  class Formatter
+    attr_accessor :template
+
+    def initialize(template_or_filename)
+      if File.exists?(template_or_filename)
+        @template = File.read(template_or_filename)
+      else
+        @template = template_or_filename
+      end
+    end
+
+    def render(locals = {})
+      ::Haml::Engine.new(template).render(self, locals)
+    end
+  end
+end

data/lib/murdoc/languages/javascript.rb

@@ -0,0 +1,43 @@
+# Javascript language module
+module Murdoc
+  module Languages
+    module Javascript
+      module Annotator
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          protected
+          def detect_source_type_from_filename(filename)
+            if File.extname(filename) == ".js"
+              :javascript
+            else
+              super if defined?(super)
+            end
+          end
+        end
+      end
+
+      module CommentSymbols
+        protected
+        def comment_symbols
+          if source_type == "javascript"
+            {:single_line => "//", :multiline => {:begin => "/*", :end => "*/"}}
+          else
+            super if defined?(super)
+          end
+        end
+      end
+    end
+  end
+
+  class Annotator
+    include Languages::Javascript::Annotator
+    include Languages::Javascript::CommentSymbols
+  end
+
+  class Paragraph
+    include Languages::Javascript::CommentSymbols
+  end
+end

data/lib/murdoc/languages/ruby.rb

@@ -0,0 +1,43 @@
+# Ruby language module
+module Murdoc
+  module Languages
+    module Ruby
+      module Annotator
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          protected
+          def detect_source_type_from_filename(filename)
+            if File.extname(filename) == ".rb"
+              :ruby
+            else
+              super if defined?(super)
+            end
+          end
+        end
+      end
+
+      module CommentSymbols
+        protected
+        def comment_symbols
+          if source_type == "ruby"
+            {:single_line => "#", :multiline => {:begin => "=begin", :end => "=end"}}
+          else
+            super if defined?(super)
+          end
+        end
+      end
+    end
+  end
+
+  class Annotator
+    include Languages::Ruby::Annotator
+    include Languages::Ruby::CommentSymbols
+  end
+
+  class Paragraph
+    include Languages::Ruby::CommentSymbols
+  end
+end

data/lib/murdoc/paragraph.rb

@@ -0,0 +1,50 @@
+require "rubygems"
+require "rdiscount"
+require "cgi"
+require "tempfile"
+
+module Murdoc
+  class Paragraph
+    attr_accessor :source
+    attr_accessor :annotation
+    attr_accessor :source_type
+    attr_accessor :starting_line
+
+    def initialize(source, annotation, starting_line = 0, source_type = nil)
+      self.source = source
+      self.annotation = annotation
+      self.starting_line = starting_line
+      self.source_type = source_type
+    end
+
+    def source_type
+      @source_type
+    end
+
+    def source_type=(source_type)
+      @source_type = source_type.to_s
+    end
+
+
+    def formatted_annotation
+      Markdown.new(annotation, :smart).to_html
+    end
+
+    def formatted_source
+      @formatted_source ||= if pygments_installed?
+        IO.popen("pygmentize -l #{source_type} -f html", "w+") do |pipe|
+          pipe.puts source
+          pipe.close_write
+          pipe.read
+        end
+      else
+        "<pre>" + CGI.escapeHTML(source) + "</pre>"
+      end
+    end
+
+    protected
+    def pygments_installed?
+      @@pygments_installed ||= ENV['PATH'].split(':').any? { |dir| File.exist?("#{dir}/pygmentize") }
+    end
+  end
+end

data/markup/stylesheet.css

@@ -0,0 +1,241 @@
+html, body {
+  min-height: 100%; }
+
+p, h1, h2, h3, ol, li, ol, ul, dt, dd, dl, body, html {
+  padding: 0;
+  margin: 0; }
+
+body {
+  width: 45%;
+  padding-left: 2.5%;
+  padding-right: 2.5%;
+  background: #7ba32d;
+  font-family: Helvetica; }
+  body:after {
+    content: ".";
+    font-size: 0.01em;
+    line-height: 0.01em;
+    display: block;
+    clear: both; }
+
+body > * {
+  padding-left: 6%;
+  padding-right: 6%; }
+
+html {
+  background: #094201; }
+
+header {
+  background: rgba(255, 255, 255, 0.1);
+  padding-top: 1em;
+  display: block; }
+  header dl {
+    margin-top: 1.125em;
+    font-size: 0.75em; }
+    header dl dt {
+      width: 5em;
+      font-weight: bold; }
+
+p, dl, li {
+  color: #c4eeff;
+  font-weight: normal; }
+
+a {
+  color: #a41717; }
+
+p {
+  margin-top: 1.5em; }
+
+h1 {
+  font-size: 2em; }
+
+h2 {
+  font-size: 1em;
+  line-height: 2em; }
+
+h1, h2, h3 {
+  color: #a41717; }
+
+ol, li {
+  margin-left: 1em; }
+
+body > div.paragraph, body > h1, body > h2 {
+  clear: both; }
+
+header {
+  padding-bottom: 1em;
+  overflow: hidden; }
+
+pre {
+  margin-top: 0;
+}
+
+dl {
+  clear: left; }
+  dl dt, dl dd {
+    float: left; }
+  dl dt {
+    clear: left; }
+  dl dd {
+    margin-left: 1em; }
+
+section {
+    clear: both;
+}
+
+figure {
+  display: block;
+  float: right;
+  margin-right: -112.5%;
+  width: 95%;
+  clear: right;
+  padding: 2.5em 5% 3em; }
+  figure > ol {
+    width: 7.5%;
+    text-align: right;
+    float: left;
+    font-size: 0.8em;
+    color: #7ba32d;
+    -webkit-border-radius: 0.2em;
+    background: rgba(255, 255, 255, 0.1);
+    border: 1px solid rgba(0, 0, 0, 0.3);
+    list-style: none;
+    margin-left: -11.25%; }
+    figure > ol li {
+      margin: 0; }
+  figure pre {
+      background: rgba(255, 255, 255, 0.5);
+      border: 1px solid rgba(0, 0, 0, 0.3);
+      border-left: none;
+      margin-bottom: 0;
+      padding-bottom: 0;
+  }
+  figure > code, figure > ol {
+    font-size: 1em;
+    font-family: monospace; }
+  figure ~ figure {
+    padding-top: 1.5em; }
+
+body .hll {
+  background-color: #ffffcc; }
+body .c {
+  color: #408080;
+  font-style: italic; }
+body .err {
+  border: 1px solid red; }
+body .k {
+  color: #954121; }
+body .o {
+  color: #666666; }
+body .cm {
+  color: #408080;
+  font-style: italic; }
+body .cp {
+  color: #bc7a00; }
+body .c1, body .cs {
+  color: #408080;
+  font-style: italic; }
+body .gd {
+  color: #a00000; }
+body .ge {
+  font-style: italic; }
+body .gr {
+  color: red; }
+body .gh {
+  color: navy;
+  font-weight: bold; }
+body .gi {
+  color: #00a000; }
+body .go {
+  color: gray; }
+body .gp {
+  color: navy;
+  font-weight: bold; }
+body .gs {
+  font-weight: bold; }
+body .gu {
+  color: purple;
+  font-weight: bold; }
+body .gt {
+  color: #0040d0; }
+body .kc {
+  color: #954121; }
+body .kd, body .kn {
+  color: #954121;
+  font-weight: bold; }
+body .kp {
+  color: #954121; }
+body .kr {
+  color: #954121;
+  font-weight: bold; }
+body .kt {
+  color: #b00040; }
+body .m {
+  color: #666666; }
+body .s {
+  color: #219161; }
+body .na {
+  color: #7d9029; }
+body .nb {
+  color: #954121; }
+body .nc {
+  color: blue;
+  font-weight: bold; }
+body .no {
+  color: #880000; }
+body .nd {
+  color: #aa22ff; }
+body .ni {
+  color: #999999;
+  font-weight: bold; }
+body .ne {
+  color: #d2413a;
+  font-weight: bold; }
+body .nf {
+  color: blue; }
+body .nl {
+  color: #a0a000; }
+body .nn {
+  color: blue;
+  font-weight: bold; }
+body .nt {
+  color: #954121;
+  font-weight: bold; }
+body .nv {
+  color: #19469d; }
+body .ow {
+  color: #aa22ff;
+  font-weight: bold; }
+body .w {
+  color: #bbbbbb; }
+body .mf, body .mh, body .mi, body .mo {
+  color: #666666; }
+body .sb, body .sc {
+  color: #219161; }
+body .sd {
+  color: #219161;
+  font-style: italic; }
+body .s2 {
+  color: #219161; }
+body .se {
+  color: #bb6622;
+  font-weight: bold; }
+body .sh {
+  color: #219161; }
+body .si {
+  color: #bb6688;
+  font-weight: bold; }
+body .sx {
+  color: #954121; }
+body .sr {
+  color: #bb6688; }
+body .s1 {
+  color: #219161; }
+body .ss {
+  color: #19469d; }
+body .bp {
+  color: #954121; }
+body .vc, body .vg, body .vi {
+  color: #19469d; }
+body .il {
+  color: #666666; }

data/markup/template.haml

@@ -0,0 +1,15 @@
+!!!
+%html
+  %head
+    %title Murdoc
+    %style=stylesheet
+  %body
+    - paragraphs.each do |p|
+      - unless p.annotation.empty?
+        %section= p.formatted_annotation
+      - unless p.source.empty?
+        %figure
+          %ol
+            - 1.upto(p.source.split("\n").size) do |i|
+              %li= i + p.starting_line
+          %code<= p.formatted_source

data/murdoc.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{murdoc}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Abramov"]
+  s.date = %q{2010-11-23}
+  s.default_executable = %q{murdoc}
+  s.description = %q{Annotated documentation generator, see README.md for details}
+  s.email = %q{markizko@gmail.com}
+  s.executables = ["murdoc"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "UNLICENSE",
+    "VERSION",
+    "autotest/discover.rb",
+    "bin/murdoc",
+    "lib/murdoc.rb",
+    "lib/murdoc/annotator.rb",
+    "lib/murdoc/formatter.rb",
+    "lib/murdoc/languages/javascript.rb",
+    "lib/murdoc/languages/ruby.rb",
+    "lib/murdoc/paragraph.rb",
+    "markup/stylesheet.css",
+    "markup/template.haml",
+    "murdoc.gemspec",
+    "spec/murdoc/annotator_spec.rb",
+    "spec/murdoc/formatter_spec.rb",
+    "spec/murdoc/paragraph_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/markiz/murdoc}
+  s.licenses = ["Public Domain"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Annotated documentation generator}
+  s.test_files = [
+    "spec/murdoc/annotator_spec.rb",
+    "spec/murdoc/formatter_spec.rb",
+    "spec/murdoc/paragraph_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_runtime_dependency(%q<rdiscount>, ["~> 1.6.5"])
+      s.add_runtime_dependency(%q<haml>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<sass>, ["~> 3.1.0"])
+      s.add_runtime_dependency(%q<haml>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<rdiscount>, ["~> 1.6.5"])
+    else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<rdiscount>, ["~> 1.6.5"])
+      s.add_dependency(%q<haml>, ["~> 3.0.0"])
+      s.add_dependency(%q<sass>, ["~> 3.1.0"])
+      s.add_dependency(%q<haml>, ["~> 3.0.0"])
+      s.add_dependency(%q<rdiscount>, ["~> 1.6.5"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<rdiscount>, ["~> 1.6.5"])
+    s.add_dependency(%q<haml>, ["~> 3.0.0"])
+    s.add_dependency(%q<sass>, ["~> 3.1.0"])
+    s.add_dependency(%q<haml>, ["~> 3.0.0"])
+    s.add_dependency(%q<rdiscount>, ["~> 1.6.5"])
+  end
+end
+

data/spec/murdoc/annotator_spec.rb

@@ -0,0 +1,111 @@
+require "spec_helper"
+require "fileutils"
+
+describe Murdoc::Annotator do
+  describe "#initialize" do
+    it "should set #source from source text" do
+      Murdoc::Annotator.new("Procrastination", "plaintext").source.should == "Procrastination"
+    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
+  end
+
+  describe ".from_file" do
+    after(:each) { FileUtils.rm "annotator_test.rb", :force => true }
+    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 "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"
+    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"
+    end
+  end
+
+
+  describe "#source=" do
+    let(:source) { "" }
+    subject { described_class.new(source, :ruby) }
+    context "for source with single-line comments" 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[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 remove trailing comment blank line" do
+        subject.source = "# Hello\n#      \n   \n\n"
+        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[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
+    end
+
+    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[0].source.should == ""
+        subject.paragraphs[0].annotation.should == "Header"
+      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"
+    end
+
+    it "should remove totally empty source" do
+      subject.source = "# Comment\n\n\n\n"
+      subject.paragraphs[0].source.should be_empty
+    end
+
+    it "should remove semi-empty lines" do
+      subject.source = "def hi\n\nend"
+      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

data/spec/murdoc/formatter_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "tempfile"
+describe Murdoc::Formatter do
+  describe "#initialize" do
+    it "should set template from given string" do
+      described_class.new("%p Hello").template.should == "%p Hello"
+    end
+
+    it "should set template from given filename if that filename exists" do
+      Tempfile.open("test") do |f|
+        f.puts("%p Hello")
+        f.close
+        described_class.new(f.path).template.should == "%p Hello\n"
+      end
+    end
+  end
+
+  describe "#render" 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

data/spec/murdoc/paragraph_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Murdoc::Paragraph do
+  describe "#initialize" do
+    it "should set source" do
+      described_class.new("A", "").source.should == "A"
+    end
+
+    it "should set annotation" do
+      described_class.new("", "B").annotation.should == "B"
+    end
+
+    it "should optionally set source_type" do
+      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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+require "bundler/setup"
+require "rspec"
+
+require "murdoc"

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification 
+name: murdoc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Abramov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-23 00:00:00 +03:00
+default_executable: murdoc
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 5
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: haml
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sass
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        - 0
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: haml
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 5
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+description: Annotated documentation generator, see README.md for details
+email: markizko@gmail.com
+executables: 
+- murdoc
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- UNLICENSE
+- VERSION
+- autotest/discover.rb
+- bin/murdoc
+- lib/murdoc.rb
+- lib/murdoc/annotator.rb
+- lib/murdoc/formatter.rb
+- lib/murdoc/languages/javascript.rb
+- lib/murdoc/languages/ruby.rb
+- lib/murdoc/paragraph.rb
+- markup/stylesheet.css
+- markup/template.haml
+- murdoc.gemspec
+- spec/murdoc/annotator_spec.rb
+- spec/murdoc/formatter_spec.rb
+- spec/murdoc/paragraph_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/markiz/murdoc
+licenses: 
+- Public Domain
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 303347797677614350
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Annotated documentation generator
+test_files: 
+- spec/murdoc/annotator_spec.rb
+- spec/murdoc/formatter_spec.rb
+- spec/murdoc/paragraph_spec.rb
+- spec/spec_helper.rb