jsus 0.3.1 → 0.3.2

data/lib/jsus/util/tree.rb

@@ -6,8 +6,7 @@ module Jsus
     # structure (with node names like /namespace/inner/item) and supporting
     # lookups via #glob method.
     #
-    # Example:
-    #
+    # @example
     #     tree = Jsus::Tree.new
     #     tree["/folder/item_0"] = "Hello"
     #     tree["/folder/item_1"] = "World"
@@ -29,6 +28,7 @@ module Jsus
 
         # Splits path into components
         #     Jsus::Tree.components_from_path("/hello/world") # => ["hello", "world"]
+        # @api semipublic
         def components_from_path(path)
           raise "Empty path given: #{path.inspect}" if !path || path == ""
           path = path.to_s.dup
@@ -68,23 +68,31 @@ module Jsus
         attr_reader :name
         # Assigns node's full path and automatically deduces path components,
         # basename etc.
+        # @api semipublic
         def full_path=(full_path)
           @full_path = full_path
           @path_components = Tree.get_path_components(full_path)
           @name = @path_components[-1]
         end
 
-        # Returns node's direct descendants
+        # @return [Array] node's direct descendants
+        # @api public
         def children
           @children ||= []
         end
 
-        # Finds a node child by basename
+        # @param [String] basename
+        # @return [Jsus::Util::Tree::Node] direct node child with given basename
+        # @api public
         def find_child(name)
           children.detect {|child| child.name == name }
         end
 
         # Creates a child with given name and value
+        # @param [String] node name
+        # @param [Object] value
+        # @return [Jsus::Util::Tree::Node]
+        # @api public
         def create_child(name, value = nil)
           full_path = Tree.path_from_components(path_components + [name])
           node = Node.new(full_path, value)
@@ -94,7 +102,11 @@ module Jsus
         end
 
         # Finds a child with given name or creates a child with given name and
-        # value
+        # value.
+        #
+        # @param [String] name
+        # @param [Object] value
+        # @api public
         def find_or_create_child(name, value = nil)
           find_child(name) || create_child(name, value)
         end
@@ -105,7 +117,10 @@ module Jsus
         #    'smth*' -- nodes beginning with smth
         #    'smth*else' -- nodes beginning with smth and ending with else
         #    <string without asterisks> -- plain node lookup by name
-        # Returns array with search results
+        #
+        # @param [String] pathspec
+        # @return [Array] array with search results
+        # @api public
         def find_children_matching(pathspec)
           case pathspec
             when "**"
@@ -118,18 +133,23 @@ module Jsus
           end
         end
 
-        # Returns whether this node has children
+        # @return [Boolean] whether this node has children
+        # @api public
         def has_children?
           !children.empty?
         end
       end
 
-      # Root node of the tree
+      # @return [Jsus::Util::Tree::Node] root node of the tree
+      # @api public
       def root
         @root ||= Node.new("/", nil)
       end
 
       # Looks up a node by direct path. Does not support wildcards
+      # @param [String] path
+      # @return [Jsus::Util::Tree::Node]
+      # @api public
       def lookup(path)
         path_components = self.class.get_path_components(path)
         path_components.inject(root) do |result, component|
@@ -139,6 +159,11 @@ module Jsus
         end
       end
 
+      # @see lookup
+      # @param [String] path
+      # @return [Jsus::Util::Tree::Node]
+      # @note returns nil when node has no assigned value
+      # @api public
       def [](path)
         node = lookup(path)
         node ? node.value : nil
@@ -147,20 +172,28 @@ module Jsus
 
 
       # Searches for nodes by a given pathspec
-      # See Jsus::Util::Tree::Node#find_children_matching for more details
+      # @see Jsus::Util::Tree::Node#find_children_matching for more details
+      # @param [String] pathspec
+      # @return [Array] nodes for given pathspec
+      # @api semipublic
       def find_nodes_matching(pathspec)
         self.class.get_path_components(pathspec).inject([root]) do |nodes, component|
           nodes.map {|node| node.find_children_matching(component) }.flatten
         end
       end
 
-      # Returns values for nodes matching given pathspec
-      # See Jsus::Util::Tree::Node#find_children_matching for more details
+      # @param [String] pathspec
+      # @return [Array] values for nodes matching given pathspec
+      # @see Jsus::Util::Tree::Node#find_children_matching for more details
+      # @api public
       def glob(pathspec)
         find_nodes_matching(pathspec).map {|node| node.value }
       end
 
       # Inserts a node with given value into the tree
+      # @param [String] full node path
+      # @param [Object] value
+      # @api public
       def insert(full_path, value = nil)
         node = create_all_nodes_if_needed(full_path)
         node.value = value
@@ -168,9 +201,10 @@ module Jsus
       end
       alias_method :[]=, :insert
 
-      # Traverses the tree.
-      # When given true as the argument, traverses all nodes.
-      # Otherwise, only leaves.
+      # Traverses the tree (BFS).
+      # @param [Boolean] whether to traverse non-leaves nodes
+      # @yield traversed node
+      # @api public
       def traverse(all_nodes = false)
         node_list = [root]
         while !node_list.empty?
@@ -180,8 +214,9 @@ module Jsus
         end
       end
 
-      # Returns a list of leaves.
-      # Returns only leaves with set values by default
+      # @param [Boolean] whether to return only leaves with values
+      # @return [Array] list of leaves
+      # @api public
       def leaves(only_with_value = true)
         result = []
         traverse {|node| result << node if !only_with_value || node.value }
@@ -190,7 +225,8 @@ module Jsus
 
       protected
 
-      def create_all_nodes_if_needed(full_path) # :nodoc:
+      # @api private
+      def create_all_nodes_if_needed(full_path)
         self.class.get_path_components(full_path).inject(root) do |result, component|
           result.find_or_create_child(component)
         end
@@ -198,4 +234,4 @@ module Jsus
 
     end
   end
-end
+end

data/lib/jsus/util/validator/base.rb

@@ -5,17 +5,21 @@ module Jsus
       class Base
         # Constructor accepts pool or array or container and adds every file
         # to its source files set.
+        # @param [Jsus::Pool, Jsus::Container, Array] source files to validate
+        # @api public
         def initialize(pool_or_array_or_container)
           self.source_files = pool_or_array_or_container
         end
 
-        # Returns source files for validation
+        # @return [Array] source files for validation
+        # @api public
         def source_files
           @source_files ||= []
         end
         alias_method :sources, :source_files
 
-        # Sets source files for validation
+        # @param [Jsus::Pool, Jsus::Container, Array] source files for validation
+        # @api public
         def source_files=(pool_or_array_or_container)
           case pool_or_array_or_container
           when Pool
@@ -28,21 +32,25 @@ module Jsus
         end
         alias_method :sources=, :source_files=
 
-        # Returns whether or not given sources conform to given set of rules
+        # @return [Boolean] whether or not given sources conform to given set of rules
+        # @api public
         def validate
           validation_errors.empty?
         end
 
-        # List of validation errors, override this method on descendant classes.
+        # @return [Array] list of validation errors
+        # @override
         def validation_errors
           []
         end
 
         # Shortcut for creating and validating a list of items
+        # @param [*Array] args for #new
+        # @api public
         def self.validate(*args)
           new(*args).validate
         end
       end
     end
   end # Util
-end
+end

data/lib/jsus/util/validator/mooforge.rb

@@ -6,7 +6,13 @@ module Jsus
       #   * Presence of authors field
       #   * Presence of license field
       class Mooforge < Base
-        def validation_errors # :nodoc:
+        # Mooforge validator checks every file for the following:
+        #   * Presence of header
+        #   * Presence of authors field
+        #   * Presence of license field
+        # @return [Array] list oferrors
+        # @api public
+        def validation_errors
           @validation_errors ||= sources.inject([]) do |result, sf|
             if !sf.header
               result << "#{sf.filename} is missing header"
@@ -22,4 +28,4 @@ module Jsus
       end
     end
   end # Util
-end
+end

data/markup/stylesheet.css

@@ -6,6 +6,10 @@ p, h1, h2, h3, ol, li, ul, dt, dd, dl, body, html {
   padding: 0;
   margin: 0; }
 
+p + br {
+  display: none;
+}
+
 body {
   width: 40%;
   padding-left: 2.5%;
@@ -27,7 +31,7 @@ body > * {
   padding-right: 6%; }
 
 html {
-  background: #FFD300; }
+  background: #FFC873; }
 
 header {
   background: rgba(255, 255, 255, 0.1);
@@ -41,10 +45,23 @@ header {
       width: 5em;
       font-weight: bold; }
 
-section, руфвук {
+section {
   float: left;
   clear: both;
-  width: 88%; }
+  width: 85%; }
+
+section iframe {
+  width: 260%;
+  height: 250px;
+  border: 1px solid #333;
+  margin-bottom: 1em;
+  margin-top: 1.5em;
+}
+
+section iframe.high {
+  height: 300px;
+}
+
 
 p, dl, li {
   color: #665504;
@@ -57,12 +74,42 @@ a {
   a:visited {
     color: #A64E00; }
 
-p {
+p + p, h2 + p, h1 + p, ul + p, ol + p{
   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;
+  padding: 0 0.2em;
+  font-family: "monaco", "Courier New", Courier, monospace, serif;
+  font-size:0.8em;
+  line-height:1.5em;
+}
+p:last-child {
+  margin-bottom: 1.5em;
+}
+
 h1 {
   font-size: 2em; }
 
+h1 + ul {
+  float: right;
+  width: 140%;
+  margin-right: -160%;
+  margin-top: -2em;
+}
+
+h1 + ul li {
+  display: inline;
+}
+
+h1 + ul li + li{
+  margin-left: 1em;
+}
+
 h2 {
   font-size: 1em; }
 
@@ -72,13 +119,18 @@ h1, h2, h3 {
 ol, li {
   margin-left: 1em; }
 
-body > p, body > h1, body > h2 {
+body > p, body > h1 {
   clear: left; }
 
+body > h2 {
+  clear: both;
+}
+
 header {
   padding-bottom: 1em;
   overflow: hidden; }
 
+
 dl {
   clear: left; }
   dl dt, dl dd {
@@ -91,29 +143,45 @@ dl {
 figure {
   display: block;
   float: right;
-  margin-right: -140%;
+  margin-right: -135%;
   width: 122.75%;
   clear: right;
-  padding: 1.5em 5% 3em; }
+  margin-top: -0.1em;
+  padding: 0 0 3em; }
   figure > ol {
-    text-shadow: 0 1px 0 #FFDE40;
-    -moz-text-shadow: 0 1px 0 #FFDE40;
-    -webkit-text-shadow: 0 1px 0 #FFDE40;
+    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;
-    font-size: 0.8em;
+    -moz-border-radius: 0.2em;
     -webkit-border-radius: 0.2em;
-    background: rgba(166, 137, 0, 0.1);
-    border: 1px solid rgba(0, 0, 0, 0.3);
+    border-radius: 0.2em;
+    border: 1px solid rgba(0, 0, 0, 0.5);
     list-style: none;
     margin-left: -9.25%; }
     figure > ol li {
+      background: rgba(125, 125, 125, 0.4);
       margin: 0; }
-  figure > code, figure > ol {
-    font-size: 1em;
-    font-family: monospace; }
+    figure > ol li:first-child {
+      border-top-left-radius: 0.2em;
+      border-top-right-radius: 0.2em; }
+    figure > ol li:last-child {
+      border-bottom-left-radius: 0.2em;
+      border-bottom-right-radius: 0.2em; }
+    figure > ol li.new {
+      background: #98B72E; }
+    figure > ol li.changed {
+      background: #FFBD40; }
   figure > code {
+    font-size: 1em;
+    line-height: 1.5em;
+    font-family: "monaco", "Courier New", Courier, monospace, serif;
     white-space: pre; }
 
 body .hll {

data/spec/data/ChainDependencies/app/javascripts/Class/package.yml

@@ -2,7 +2,7 @@ name: Class
 filename: class.js
 description: Class class
 license: MIT-Style License, http://mootools.net/license
-copyright: Somebody
+copyright: © Somebody
 authors: Someone
 sources:
-  - Source/Class.js
+  - Source/Class.js

data/spec/jsus/middleware_spec.rb

@@ -205,6 +205,31 @@ describe Jsus::Middleware do
         body.index("script: Color.js").should > body.index("script: Core.js")
       end
     end
+
+    describe "using /include/ pattern" do
+      let(:path) { "/javascripts/jsus/include/Package:Input.Color.js" }
+
+      it "should be successful" do
+        get(path).should be_successful
+      end
+
+      it "should respond with type text/javascript" do
+        get(path).content_type.should == "text/javascript"
+      end
+
+      it "should contain filenames for required files" do
+        get(path).body.should include("/Color.js")
+        get(path).body.should include("/Input.js")
+        get(path).body.should include("/Input.Color.js")
+      end
+
+      it "should respect :includes_root setting" do
+        old_settings = Jsus::Middleware.settings
+        Jsus::Middleware.settings = {:includes_root => File.expand_path("../../data/ComplexDependencies/Mootools/Source", __FILE__)}
+        get(path).body.should include("../../Source/Library/Color.js")
+        Jsus::Middleware.settings = old_settings
+      end
+    end
   end
 
   describe "for invalid paths" do