jsus 0.1.11 → 0.1.12

data/Gemfile

@@ -8,4 +8,4 @@ gem "activesupport"
 gem "json_pure"
 gem "rgl"
 gem "choice"
-
+gem "murdoc"

data/Gemfile.lock

@@ -5,12 +5,22 @@ GEM
     choice (0.1.4)
     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
     json_pure (1.4.6)
+    murdoc (0.1.3)
+      haml (~> 3.0.0)
+      haml (~> 3.0.0)
+      jeweler
+      rdiscount (~> 1.6.5)
+      rdiscount (~> 1.6.5)
+      rspec (~> 2.1.0)
+      sass (~> 3.1.0)
     rake (0.8.7)
+    rdiscount (1.6.5)
     rgl (0.4.0)
       rake
       stream (>= 0.5)
@@ -22,6 +32,7 @@ GEM
     rspec-expectations (2.1.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.1.0)
+    sass (3.1.0.alpha.39)
     stream (0.5)
 
 PLATFORMS
@@ -33,5 +44,6 @@ DEPENDENCIES
   choice
   jeweler
   json_pure
+  murdoc
   rgl
   rspec

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.1.12

data/bin/jsus

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'jsus'
-start_time = Time.now
+require "fileutils"
+require "murdoc"
 require 'choice'
-
+start_time = Time.now
 
 Choice.options do
   option 'input_directory', :required => true do
@@ -51,6 +52,13 @@ Choice.options do
          "compile the package"
   end
 
+  option "docs_classes", :required => false do
+    default []
+    long "--generate-docs *CLASSES"
+    desc "Generate documentation for classes via murdoc, e.g.: lsd-* mootools-*"
+
+  end
+
 end
 
 compile_start_time = Time.now
@@ -82,7 +90,29 @@ if Choice.choices[:generate_includes]
   end
 end
 
+# Generate documentation
+unless Choice.choices[:docs_classes].empty?
+  documented_sources = Jsus::Container.new
+  sources = pool ? pool.sources : package.source_files
+  Choice.choices[:docs_classes].each do |expr|
+    regex = Regexp.new("^" + expr.gsub("*", ".*") + "$", Regexp::IGNORECASE)
+    sources.each {|s| documented_sources << s if s.provides.any? {|provided| provided.to_s =~ regex } }
+  end
 
+  doc_dir = Choice.choices[:output_directory] + "/docs"
+  FileUtils.mkdir_p(doc_dir)
+  template = File.dirname(__FILE__) + "/../markup/template.haml"
+  documented_sources.each do |source|
+    content = source.original_content.gsub(/\A\s*\/\*.*?\*\//m, "") # deleting initial comment
+    annotator = Murdoc::Annotator.new(content, :javascript, :highlight_source => true)
+    header = source.header
+    File.open("#{doc_dir}/#{File.basename(source.filename)}.html", "w+") do |f|
+      f.puts Murdoc::Formatter.new(template).render(:paragraphs => annotator.paragraphs, :header => header, :source => source)
+    end
+  end
+
+  FileUtils.cp(File.dirname(__FILE__) + "/../markup/stylesheet.css", doc_dir)
+end
 
 finish_time = Time.now
 

data/jsus.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsus}
-  s.version = "0.1.11"
+  s.version = "0.1.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Abramov"]
@@ -41,6 +41,8 @@ Gem::Specification.new do |s|
     "lib/jsus/pool.rb",
     "lib/jsus/source_file.rb",
     "lib/jsus/tag.rb",
+    "markup/stylesheet.css",
+    "markup/template.haml",
     "spec/data/Basic/README",
     "spec/data/Basic/app/javascripts/Orwik/Source/Library/Color.js",
     "spec/data/Basic/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js",
@@ -126,6 +128,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<json_pure>, [">= 0"])
       s.add_runtime_dependency(%q<rgl>, [">= 0"])
       s.add_runtime_dependency(%q<choice>, [">= 0"])
+      s.add_runtime_dependency(%q<murdoc>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_runtime_dependency(%q<json_pure>, [">= 0"])
       s.add_runtime_dependency(%q<rgl>, [">= 0"])
@@ -138,6 +141,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<json_pure>, [">= 0"])
       s.add_dependency(%q<rgl>, [">= 0"])
       s.add_dependency(%q<choice>, [">= 0"])
+      s.add_dependency(%q<murdoc>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<json_pure>, [">= 0"])
       s.add_dependency(%q<rgl>, [">= 0"])
@@ -151,6 +155,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<json_pure>, [">= 0"])
     s.add_dependency(%q<rgl>, [">= 0"])
     s.add_dependency(%q<choice>, [">= 0"])
+    s.add_dependency(%q<murdoc>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<json_pure>, [">= 0"])
     s.add_dependency(%q<rgl>, [">= 0"])

data/lib/jsus/source_file.rb

@@ -218,6 +218,10 @@ module Jsus
       [@content, extensions.map {|e| e.content}].flatten.compact.join("\n")
     end 
     
+    def original_content # :nodoc:
+      @content
+    end
+
     # Assigns an instance of Jsus::Pool to the source file.
     # Also performs push to that pool.
     def pool=(new_value)

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,47 @@
+!!!
+%html
+  %head
+    %title Documentaiton for #{header["script"]}
+    %link{:rel => "stylesheet", :href => "stylesheet.css"}
+  %body
+    %figure
+      - if header["requires"]
+        %h2 Requires
+        %ul
+          - [header["requires"]].flatten.each do |r|
+            %li #{r}
+      - if header["provides"]
+        %h2 Provides
+        %ul
+          - [header["provides"]].flatten.each do |p|
+            %li #{p}
+
+    %header
+      - if header["script"]
+        %h1 #{header["script"]}
+      - if header["description"]
+        %p #{header["description"]}
+
+      %dl
+        - if header["license"]
+          %dt License:
+          %dd #{header["license"]}
+
+        - if header["authors"]
+          %dt Authors:
+          %dd #{header["authors"].join(", ")}
+        - if header["author"]
+          %dt Author:
+          %dd #{header["author"]}
+
+
+    - paragraphs.each do |paragraph|
+      - unless paragraph.annotation.empty?
+        %section
+          = paragraph.formatted_annotation
+      - unless paragraph.source.empty?
+        %figure
+          %ol
+            - 1.upto(paragraph.source.split("\n").size) do |line|
+              %li #{line + paragraph.starting_line}          
+          %code<= paragraph.formatted_source

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 11
-  version: 0.1.11
+  - 12
+  version: 0.1.12
 platform: ruby
 authors: 
 - Mark Abramov
@@ -109,7 +109,7 @@ dependencies:
   prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: murdoc
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -122,7 +122,7 @@ dependencies:
   prerelease: false
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: json_pure
+  name: activesupport
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -135,7 +135,7 @@ dependencies:
   prerelease: false
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: rgl
+  name: json_pure
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -148,7 +148,7 @@ dependencies:
   prerelease: false
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: choice
+  name: rgl
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -160,6 +160,19 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: choice
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id012
 description: Javascript packager and dependency resolver
 email: markizko@gmail.com
 executables: 
@@ -192,6 +205,8 @@ files:
 - lib/jsus/pool.rb
 - lib/jsus/source_file.rb
 - lib/jsus/tag.rb
+- markup/stylesheet.css
+- markup/template.haml
 - spec/data/Basic/README
 - spec/data/Basic/app/javascripts/Orwik/Source/Library/Color.js
 - spec/data/Basic/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js
@@ -262,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1053208983668858724
+      hash: 1278848259045300436
       segments: 
       - 0
       version: "0"