murdoc 0.1.13 → 0.2.0

data/lib/murdoc/version.rb

@@ -0,0 +1,3 @@
+module Murdoc
+  VERSION = '0.2.0'
+end

data/markup/stylesheet.css

@@ -1,22 +1,28 @@
-html, body {
+body, .document, html {
   min-height: 100%;
   line-height: 1.5; }
 
-p, h1, h2, h3, ol, li, ul, dt, dd, dl, body, html {
+p, h1, h2, h3, ol, li, ul, dt, dd, dl, .document, body {
   padding: 0;
   margin: 0; }
 
-p + br {
-  display: none;
-}
 
-body {
+.document {
   width: 40%;
   padding-left: 2.5%;
   padding-right: 2.5%;
-  background: #BFA730;
+  padding-top: 3em;
+  background: #eaeaea;
   font-family: Helvetica; }
-  body:after {
+  .document + .document {
+    padding-top: 3em;
+    margin-top: 2em;
+    border-top: 1.5em solid #ddd;
+    -moz-border-radius: 0 2px 2px 0;
+    -webkit-border-radius: 0 2px 2px 0;
+    border-radius:  0 2px 2px 0;
+  }
+  .document:after {
     content: ".";
     font-size: 0.01em;
     line-height: 0.01em;
@@ -26,12 +32,16 @@ body {
 figure#relations h2 ~ h2 {
   margin-top: 1.5em; }
 
-body > * {
+h2,h3,h1,p {
+  line-height: 1.5rem;
+}
+
+.document > * {
   padding-left: 6%;
   padding-right: 6%; }
 
-html {
-  background: #FFC873; }
+body {
+  background: #333; }
 
 header {
   background: rgba(255, 255, 255, 0.1);
@@ -74,15 +84,15 @@ a {
   a:visited {
     color: #A64E00; }
 
-p + p, h2 + p, h1 + p, ul + p, ol + p{
+p + p, h2 + p, h1 + p, ul + p, ol + p, h1 + ul, h2 + ul, ul + h1, ul + h2, p + h1, p + h2 {
   margin-top: 1.5em; }
 
 p code {
   background-color: rgba(200, 220, 200, 0.2);
   display: inline-block;
-  -moz-border-radius: 4px;
-  -webkit-border-radius: 4px;
-  border-radius: 4px;
+  -moz-border-radius: 2px;
+  -webkit-border-radius: 2px;
+  border-radius: 2px;
   padding: 0 0.2em;
   font-family: "monaco", "Courier New", Courier, monospace, serif;
   font-size:0.8em;
@@ -92,40 +102,49 @@ p:last-child {
   margin-bottom: 1.5em;
 }
 
-h1 {
-  font-size: 2em; }
-
-h1 + ul {
+label {
+  font-size: 1em;
   float: right;
-  width: 140%;
-  margin-right: -160%;
-  margin-top: -2em;
+  position: relative;
+  z-index: 20;
+  margin-right: -18%;
+  padding: 0 1.5%;
+  background: rgba(0,0,0, 0.6);
+  -moz-border-radius: 2px 0 0 2px;
+  -webkit-border-radius: 2px 0 0 2px;
+  border-radius: 2px 0 0 2px;
+  color: #fff;
+  font-weight: normal;
+  font-family: "monaco", "Courier New", Courier, monospace, serif;
+  font-size:0.9em;
+  line-height: 1.5rem;
 }
 
-h1 + ul li {
-  display: inline;
+h1 {
+  font-size: 2em;
 }
 
-h1 + ul li + li{
-  margin-left: 1em;
-}
 
 h2 {
-  font-size: 1em; }
+  font-size: 1.5em;
+  font-weight: normal;}
 
 h1, h2, h3 {
-  color: #A41717; }
+  color: #444; }
+
+h3 {
+  font-family: Times, serif;
+  text-transform: uppercase;
+  font-weight: normal;
+
+}
 
 ol, li {
   margin-left: 1em; }
 
-body > p, body > h1 {
+.document > p, .document > h1, .document > h2 {
   clear: left; }
 
-body > h2 {
-  clear: both;
-}
-
 header {
   padding-bottom: 1em;
   overflow: hidden; }
@@ -143,31 +162,27 @@ dl {
 figure {
   display: block;
   float: right;
+  margin: 0;
   margin-right: -135%;
-  width: 122.75%;
+  width: 114.75%;
   clear: right;
-  margin-top: -0.1em;
-  padding: 0 0 3em; }
+  padding: 0 0 3em;}
   figure > ol {
     font-family: 0.75em/2.25em Arial;
-    text-shadow: 0 1px 0 #eee;
-    -moz-text-shadow: 0 1px 0 #eee;
-    -webkit-text-shadow: 0 1px 0 #eee;
-    box-shadow: 0 1px 2px #333;
-    -moz-box-shadow: 0 1px 2px #333;
-    -webkit-box-shadow: 0 1px 2px #333;
     width: 7.5%;
     text-align: right;
     float: left;
     -moz-border-radius: 0.2em;
     -webkit-border-radius: 0.2em;
     border-radius: 0.2em;
-    border: 1px solid rgba(0, 0, 0, 0.5);
     list-style: none;
-    margin-left: -9.25%; }
+    margin-left: -10.75%;}
     figure > ol li {
-      background: rgba(125, 125, 125, 0.4);
-      margin: 0; }
+      background: rgba(230,230,230,0.7);
+      padding: 0 3px 0 0;
+      color: #666;
+      margin: 0;
+      line-height: 1.5rem; }
     figure > ol li:first-child {
       border-top-left-radius: 0.2em;
       border-top-right-radius: 0.2em; }
@@ -175,135 +190,83 @@ figure {
       border-bottom-left-radius: 0.2em;
       border-bottom-right-radius: 0.2em; }
     figure > ol li.new {
-      background: #98B72E; }
+      background: #98B72E;}
     figure > ol li.changed {
       background: #FFBD40; }
   figure > code {
     font-size: 1em;
-    line-height: 1.5em;
+    line-height: 1.5rem;
     font-family: "monaco", "Courier New", Courier, monospace, serif;
-    white-space: pre; }
+    white-space: pre;
+    color: #fff;}
 
-body .hll {
-  background-color: #ffffcc; }
-body .c {
-  color: #408080;
-  font-style: italic; }
-body .err {
-  border: 1px solid #FF0000; }
-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: #FF0000; }
-body .gh {
-  color: #000080;
-  font-weight: bold; }
-body .gi {
-  color: #00A000; }
-body .go {
-  color: #808080; }
-body .gp {
-  color: #000080;
-  font-weight: bold; }
-body .gs {
-  font-weight: bold; }
-body .gu {
-  color: #800080;
-  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: #0000FF;
-  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: #0000FF; }
-body .nl {
-  color: #A0A000; }
-body .nn {
-  color: #0000FF;
-  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; }
+.codehilite code, .codehilite pre{color:#fdce93;background-color:#3f3f3f}
+.hll{background-color:#222}
+.c{color:#7f9f7f}
+.err{color:#e37170;background-color:#3d3535}
+.g{color:#7f9f7f}
+.k{color:#f0dfaf}
+.l{color:#ccc}
+.n{color:#dcdccc}
+.o{color:#f0efd0}
+.x{color:#ccc}
+.p{color:#41706f}
+.cm{color:#7f9f7f}
+.cp{color:#7f9f7f}
+.c1{color:#7f9f7f}
+.cs{color:#cd0000;font-weight:bold}
+.gd{color:#cd0000}
+.ge{color:#ccc;font-style:italic}
+.gr{color:red}
+.gh{color:#dcdccc;font-weight:bold}
+.gi{color:#00cd00}
+.go{color:gray}
+.gp{color:#dcdccc;font-weight:bold}
+.gs{color:#ccc;font-weight:bold}
+.gu{color:purple;font-weight:bold}
+.gt{color:#0040D0}
+.kc{color:#dca3a3}
+.kd{color:#ffff86}
+.kn{color:#dfaf8f;font-weight:bold}
+.kp{color:#cdcf99}
+.kr{color:#cdcd00}
+.kt{color:#00cd00}
+.ld{color:#cc9393}
+.m{color:#8cd0d3}
+.s{color:#cc9393}
+.na{color:#9ac39f}
+.nb{color:#efef8f}
+.nc{color:#efef8f}
+.no{color:#ccc}
+.nd{color:#ccc}
+.ni{color:#c28182}
+.ne{color:#c3bf9f;font-weight:bold}
+.nf{color:#efef8f}
+.nl{color:#ccc}
+.nn{color:#8fbede}
+.nx{color:#ccc}
+.py{color:#ccc}
+.nt{color:#9ac39f}
+.nv{color:#dcdccc}
+.ow{color:#f0efd0}
+.w{color:#ccc}
+.mf{color:#8cd0d3}
+.mh{color:#8cd0d3}
+.mi{color:#8cd0d3}
+.mo{color:#8cd0d3}
+.sb{color:#cc9393}
+.sc{color:#cc9393}
+.sd{color:#cc9393}
+.s2{color:#cc9393}
+.se{color:#cc9393}
+.sh{color:#cc9393}
+.si{color:#cc9393}
+.sx{color:#cc9393}
+.sr{color:#cc9393}
+.s1{color:#cc9393}
+.ss{color:#cc9393}
+.bp{color:#efef8f}
+.vc{color:#efef8f}
+.vg{color:#dcdccc}
+.vi{color:#ffffc7}
+.il{color:#8cd0d3}

data/markup/template.haml

@@ -4,12 +4,13 @@
     %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.gsub("\n", '&#x000A;')}</code>
+    .document{:class => annotated_file.source_type}
+      - annotated_file.formatted_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.gsub("\n", '&#x000A;')}</code>

data/markup/template_multifile.haml

@@ -4,14 +4,16 @@
     %title Murdoc
     %style=stylesheet
   %body
-    - annotators.each_with_index do |annotator, i|
-      %h2 #{filenames[i]}
-      - annotator.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.gsub("\n", '&#x000A;')}</code>
+    - annotated_files.each do |af|
+      .document{:class => af.source_type}
+        - af.formatted_paragraphs.each_with_index do |p, j|
+          %section
+            - if j == 0
+              %label= File.basename(af.filename)
+            = 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.gsub("\n", '&#x000A;')}</code>

data/murdoc.gemspec

@@ -1,82 +1,34 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: murdoc 0.1.13 ruby lib
 
-Gem::Specification.new do |s|
-  s.name = "murdoc"
-  s.version = "0.1.13"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'murdoc/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Mark Abramov"]
-  s.date = "2015-07-06"
-  s.description = "Annotated documentation generator, see README.md for details"
-  s.email = "markizko@gmail.com"
-  s.executables = ["murdoc", "murdoc-strip-comments"]
-  s.extra_rdoc_files = [
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".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/languages/html.rb",
-    "lib/murdoc/languages/javascript.rb",
-    "lib/murdoc/languages/ruby.rb",
-    "lib/murdoc/paragraph.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/paragraph_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/markiz/murdoc"
-  s.licenses = ["Public Domain"]
-  s.rubygems_version = "2.4.5"
-  s.summary = "Annotated documentation generator"
+Gem::Specification.new do |spec|
+  spec.name = "murdoc"
+  spec.version = Murdoc::VERSION
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  spec.required_rubygems_version = Gem::Requirement.new(">= 0") if spec.respond_to? :required_rubygems_version=
+  spec.require_paths = ["lib"]
+  spec.authors = ["Mark Abramov"]
+  spec.date = "2015-07-06"
+  spec.description = "Annotated documentation generator, see README.md for details"
+  spec.email = "markizko@gmail.com"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<kramdown>, [">= 0"])
-      s.add_runtime_dependency(%q<haml>, ["~> 3.0.0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.4.0"])
-      s.add_development_dependency(%q<rdiscount>, ["~> 1.6.5"])
-    else
-      s.add_dependency(%q<kramdown>, [">= 0"])
-      s.add_dependency(%q<haml>, ["~> 3.0.0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.4.0"])
-      s.add_dependency(%q<rdiscount>, ["~> 1.6.5"])
-    end
-  else
-    s.add_dependency(%q<kramdown>, [">= 0"])
-    s.add_dependency(%q<haml>, ["~> 3.0.0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.4.0"])
-    s.add_dependency(%q<rdiscount>, ["~> 1.6.5"])
-  end
+  spec.homepage = "http://github.com/markiz/murdoc"
+  spec.licenses = ["Public Domain"]
+  spec.rubygems_version = "2.4.5"
+  spec.summary = "Annotated documentation generator"
+
+  spec.add_dependency 'kramdown', '~> 0.13'
+  spec.add_dependency 'haml', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rdiscount', '~> 1.6.5' unless RUBY_PLATFORM =~ /java/
 end