jsus 0.2.5 → 0.2.6

data/spec/jsus/{documenter_spec.rb → util/documenter_spec.rb}

@@ -1,14 +1,14 @@
 require "spec_helper"
 
-describe Jsus::Documenter do
+describe Jsus::Util::Documenter do
   subject { described_class.new }
-  let(:input_dir) { "#{File.dirname(__FILE__)}/../data/Basic/app/javascripts/Orwik" }
+  let(:input_dir) { "spec/data/Basic/app/javascripts/Orwik" }
   let(:pool) { Jsus::Pool.new(input_dir) }
 
   describe "<<" do
     it "should add source files to tree" do
       pool.sources.each {|s| subject << s}
-      subject.tree["/Orwik/Color.js"].value.should be_a(Jsus::SourceFile)
+      subject.tree["/Orwik/Color.js"].should be_a(Jsus::SourceFile)
     end
   end
 

data/spec/jsus/{tree_spec.rb → util/tree_spec.rb}

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Jsus::Tree::Node do
+describe Jsus::Util::Tree::Node do
   describe "#initialize" do
     it "should accept full path" do
       described_class.new("/path/node", nil).full_path.should == "/path/node"
@@ -17,7 +17,7 @@ describe Jsus::Tree::Node do
 
   describe "#children" do
     subject { described_class.new("/") }
-    
+
     it "should be initialized with an empty array" do
       subject.children.should == []
     end
@@ -38,7 +38,7 @@ describe Jsus::Tree::Node do
     it "if it matches a child name, it should return that child" do
       subject.find_children_matching("one").should == [nodes[0]]
     end
-    
+
     it "if it is *, it should return children, not containing other children" do
       subject.find_children_matching("*").should == [nodes[1]]
     end
@@ -53,12 +53,12 @@ describe Jsus::Tree::Node do
   end
 end
 
-describe Jsus::Tree do
-  subject { Jsus::Tree.new }
+describe Jsus::Util::Tree do
+  subject { described_class.new }
 
   describe "#root" do
     it "should create node if needed" do
-      subject.root.should be_a(Jsus::Tree::Node)
+      subject.root.should be_a(Jsus::Util::Tree::Node)
     end
 
     it "should not recreate node" do
@@ -72,7 +72,7 @@ describe Jsus::Tree do
       subject.root.children.should have_exactly(1).element
       subject.root.children[0].value.should == "Value"
     end
-    
+
     it "should create all underlying nodes if needed" do
       subject.insert("/hello/world", "value")
       subject.root.children[0].children[0].value.should == "value"
@@ -96,26 +96,76 @@ describe Jsus::Tree do
     it "should return a node" do
       subject.insert("/hello/world", "value").value.should == "value"
     end
+
+    it "should prepend leading slash" do
+      subject.insert("hello", "world")
+      subject.root.children[0].full_path.should == "/hello"
+      subject.root.children[0].value.should == "world"
+    end
+
+    it "should allow tags for nodes insertion" do
+      subject.insert(Jsus::Tag["hello"], "world")
+      subject.root.children[0].full_path.should == "/hello"
+      subject.root.children[0].value.should == "world"
+    end
   end
 
-  describe "#[]" do
-    it "should raise error unless path starts with root" do
-      lambda { subject["hello"] }.should raise_error      
+  describe "#lookup" do
+    it "should return nil if node is not found" do
+      subject.lookup("/hello").should be_nil
+      subject.lookup("/hello/world").should be_nil
     end
 
     it "should allow to get node by path" do
-      subject.insert("/hello/world", 123)
-      subject["/hello/world"].value.should == 123
+      subject["/hello/world"] = 123
+      subject.lookup("/hello/world").value.should == 123
+    end
+
+    it "should prepend leading slash if needed" do
+      subject["/hello"] = "world"
+      subject.lookup("hello").should_not be_nil
+    end
+
+    it "should raise error for empty paths" do
+      lambda { subject.lookup("") }.should raise_error
+      lambda { subject.lookup(nil) }.should raise_error
     end
 
+    it "should allow tags for node lookup" do
+      subject["/Core/Moo"] = "Tools"
+      subject.lookup(Jsus::Tag["Core/Moo"]).value.should == "Tools"
+    end
+  end
+
+  describe "#[]" do
     it "should return nil if node is not found" do
       subject["/hello"].should be_nil
       subject["/hello/world"].should be_nil
     end
+
+    it "should allow to get node value by path" do
+      subject["/hello/world"] = 123
+      subject["/hello/world"].should == 123
+    end
+
+    it "should prepend leading slash to path if needed" do
+      subject["/hello"] = "world"
+      subject["hello"].should == "world"
+    end
+
+    it "should raise error for empty paths" do
+      lambda { subject[""] }.should raise_error
+      lambda { subject[nil] }.should raise_error
+    end
+
+    it "should allow tags for node lookup" do
+      subject["/Core/Moo"] = "Tools"
+      subject[Jsus::Tag["Core/Moo"]].should == "Tools"
+    end
   end
 
-  describe "#glob" do
-    subject { Jsus::Tree.new }
+  describe "#find_nodes_matching" do
+    subject { described_class.new }
     let(:nodes) { [] }
     before(:each) do
       nodes << subject.insert("/hello/world/one", 1) <<
@@ -125,19 +175,53 @@ describe Jsus::Tree do
     end
 
     it "should return the node if exact path is given" do
-      subject.glob("/hello/four").should == [nodes[3]]
+      subject.find_nodes_matching("/hello/four").should == [nodes[3]]
     end
 
-    it "should return all nodes in given node AND WITHOUT CHILDREN if path with wildcard is given" do
-      subject.glob("/hello/*").should =~ [nodes[2], nodes[3]]
+    it "should return all matching children of given node excluding subtrees if path with wildcard is given" do
+      subject.find_nodes_matching("/hello/*").should =~ [nodes[2], nodes[3]]
     end
 
     it "should search for children matching wildcards" do
-      subject.glob("/hello/thr*").should == [nodes[2]]
+      subject.find_nodes_matching("/hello/thr*").should == [nodes[2]]
     end
 
-    it "should return all nodes in all subtrees and in the given subtree if double wildcard is given" do
-      subject.glob("/hello/**/*").should =~ nodes
+    it "should return all nodes in all subtrees of the prefix subtree if double wildcard is given" do
+      subject.find_nodes_matching("/hello/world/**/*").should =~ [nodes[0], nodes[1]]
+      subject.find_nodes_matching("/hello/**/*").should =~ nodes
+    end
+
+    it "should not choke when it cannot find anything" do
+      subject.find_nodes_matching("/ololo").should == []
+      subject.find_nodes_matching("/ololo/mwahaha").should == []
+    end
+  end
+
+  describe "#glob" do
+    subject { described_class.new }
+    let(:nodes) { [] }
+    before(:each) do
+      nodes << subject.insert("/hello/world/one", 1) <<
+               subject.insert("/hello/world/two", 2) <<
+               subject.insert("/hello/three", 3)     <<
+               subject.insert("/hello/four", 4)
+    end
+
+    it "should return the node value if exact path is given" do
+      subject.glob("/hello/four").should == [4]
+    end
+
+    it "should return all matching children of given node excluding subtrees if path with wildcard is given" do
+      subject.glob("/hello/*").should =~ [3, 4]
+    end
+
+    it "should search for children matching wildcards" do
+      subject.glob("/hello/thr*").should == [3]
+    end
+
+    it "should return all node values in all subtrees of the prefix subtree if double wildcard is given" do
+      subject.glob("/hello/world/**/*").should =~ [1, 2]
+      subject.glob("/hello/**/*").should =~ [1, 2, 3, 4]
     end
 
     it "should not choke when it cannot find anything" do
@@ -147,7 +231,7 @@ describe Jsus::Tree do
   end
 
   describe "#traverse" do
-    subject { Jsus::Tree.new }
+    subject { described_class.new }
     let(:nodes) { [] }
     before(:each) do
       nodes << subject.insert("/hello/world/one", 1) <<
@@ -165,12 +249,12 @@ describe Jsus::Tree do
     it "should traverse all nodes if given a true argument" do
       counter = 0
       subject.traverse(true) { counter += 1 }
-      counter.should == 7    
+      counter.should == 7
     end
   end
 
   describe "#leaves" do
-    subject { Jsus::Tree.new }
+    subject { described_class.new }
     let(:nodes) { [] }
     before(:each) do
       nodes << subject.insert("/hello/world/one", 1) <<
@@ -178,16 +262,16 @@ describe Jsus::Tree do
                subject.insert("/hello/three", nil)     <<
                subject.insert("/hello/four", 4)
     end
-    
+
     it "should return only the leaves with content by default" do
       subject.leaves.should =~ [nodes[0], nodes[1], nodes[3]]
     end
-    
-    
+
+
     it "should return all the leaves if asked" do
       subject.leaves(false).should =~ nodes
     end
-    
+
   end
 
 end

data/spec/jsus/{validator → util/validator}/base_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Jsus::Validator::Base do
+describe Jsus::Util::Validator::Base do
   subject { described_class.new(pool) }
   let(:input_dir) { "spec/data/ChainDependencies/app/javascripts" }
   let!(:pool) { Jsus::Pool.new(input_dir) }
@@ -8,11 +8,11 @@ describe Jsus::Validator::Base do
     it "should accept pool as the first argument" do
       described_class.new(pool).source_files.should =~ pool.sources.to_a
     end
-    
+
     it "should accept container as the first argument" do
       described_class.new(pool.sources).source_files.should =~ pool.sources.to_a
-    end    
-    
+    end
+
     it "should accept array as the first argument" do
       described_class.new(pool.sources.to_a).source_files.should =~ pool.sources.to_a
     end
@@ -21,7 +21,7 @@ describe Jsus::Validator::Base do
   it "should respond to #validate method" do
     subject.should respond_to(:validate)
   end
-  
+
   describe ".validate" do
     it "should be the same as calling new + validate" do
       validator = mock

data/spec/jsus/{validator → util/validator}/mooforge_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Jsus::Validator::Mooforge do
+describe Jsus::Util::Validator::Mooforge do
   describe "#validate" do
     let(:input_dir) { "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library" }
     let!(:sources) {
@@ -11,20 +11,20 @@ describe Jsus::Validator::Mooforge do
       described_class.validate([sources[0]]).should be_true
       described_class.new([sources[0]]).validation_errors.should == []
     end
-    
+
     it "should return false for files without authors" do
       described_class.validate([sources[1]]).should be_false
       described_class.new([sources[1]]).validation_errors[0].should include(sources[1].filename)
     end
-    
+
     it "should return false for files without license" do
       described_class.validate([sources[2]]).should be_false
       described_class.new([sources[2]]).validation_errors[0].should include(sources[2].filename)
-    end    
-        
+    end
+
     it "should return false when some of the files fail" do
       described_class.validate(sources).should be_false
-      described_class.new(sources).validation_errors.size.should == 2      
-    end    
+      described_class.new(sources).validation_errors.size.should == 2
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jsus
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Mark Abramov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-04 00:00:00 -05:00
+date: 2011-03-07 00:00:00 -05:00
 default_executable: jsus
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -233,16 +233,17 @@ files:
 - jsus.gemspec
 - lib/jsus.rb
 - lib/jsus/container.rb
-- lib/jsus/documenter.rb
 - lib/jsus/package.rb
 - lib/jsus/packager.rb
 - lib/jsus/pool.rb
 - lib/jsus/source_file.rb
 - lib/jsus/tag.rb
-- lib/jsus/tree.rb
-- lib/jsus/validator.rb
-- lib/jsus/validator/base.rb
-- lib/jsus/validator/mooforge.rb
+- lib/jsus/util.rb
+- lib/jsus/util/documenter.rb
+- lib/jsus/util/tree.rb
+- lib/jsus/util/validator.rb
+- lib/jsus/util/validator/base.rb
+- lib/jsus/util/validator/mooforge.rb
 - markup/index_template.haml
 - markup/stylesheet.css
 - markup/template.haml
@@ -311,15 +312,15 @@ files:
 - spec/data/bad_test_source_two.js
 - spec/data/test_source_one.js
 - spec/jsus/container_spec.rb
-- spec/jsus/documenter_spec.rb
 - spec/jsus/package_spec.rb
 - spec/jsus/packager_spec.rb
 - spec/jsus/pool_spec.rb
 - spec/jsus/source_file_spec.rb
 - spec/jsus/tag_spec.rb
-- spec/jsus/tree_spec.rb
-- spec/jsus/validator/base_spec.rb
-- spec/jsus/validator/mooforge_spec.rb
+- spec/jsus/util/documenter_spec.rb
+- spec/jsus/util/tree_spec.rb
+- spec/jsus/util/validator/base_spec.rb
+- spec/jsus/util/validator/mooforge_spec.rb
 - spec/shared/class_stubs.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -358,14 +359,14 @@ specification_version: 3
 summary: Javascript packager and dependency resolver
 test_files: 
 - spec/jsus/container_spec.rb
-- spec/jsus/documenter_spec.rb
 - spec/jsus/package_spec.rb
 - spec/jsus/packager_spec.rb
 - spec/jsus/pool_spec.rb
 - spec/jsus/source_file_spec.rb
 - spec/jsus/tag_spec.rb
-- spec/jsus/tree_spec.rb
-- spec/jsus/validator/base_spec.rb
-- spec/jsus/validator/mooforge_spec.rb
+- spec/jsus/util/documenter_spec.rb
+- spec/jsus/util/tree_spec.rb
+- spec/jsus/util/validator/base_spec.rb
+- spec/jsus/util/validator/mooforge_spec.rb
 - spec/shared/class_stubs.rb
 - spec/spec_helper.rb

data/lib/jsus/documenter.rb

@@ -1,99 +0,0 @@
-module Jsus
-  class Documenter
-    attr_accessor :options
-
-    def initialize(options = {:highlight_source => true})
-      require "murdoc"
-      self.options = options
-    rescue LoadError
-      raise "You should install murdoc gem in order to produce documentation"
-    end
-
-    def generate(doc_dir = Dir.pwd)
-      #FileUtils.rm_rf(doc_dir)
-      FileUtils.mkdir_p(doc_dir)
-      template_path = File.dirname(__FILE__) + "/../../markup"
-      template = File.read("#{template_path}/template.haml")
-      index_template = File.read("#{template_path}/index_template.haml")
-      stylesheet_path = "#{template_path}/stylesheet.css"
-      documented_sources.traverse(true) do |node|
-        if node.value # leaf
-          dir = doc_dir + File.dirname(node.full_path)
-          FileUtils.mkdir_p(dir)
-          file_from_contents(dir + "/#{node.name}.html", create_documentation_for_source(node.value, template))
-        else
-          dir = doc_dir + node.full_path
-          FileUtils.mkdir_p(dir)
-          FileUtils.cp(stylesheet_path, dir)
-          file_from_contents(dir + "/index.html", create_index_for_node(node, index_template))
-        end
-      end
-    end
-
-    def create_documentation_for_source(source, template)
-      skipped_lines = 0
-      content = source.original_content.gsub(/\A\s*\/\*.*?\*\//m) {|w| skipped_lines += w.split("\n").size; "" }
-      annotator = Murdoc::Annotator.new(content, :javascript, options)
-      Murdoc::Formatter.new(template).render(:paragraphs => annotator.paragraphs, :header => source.header, :source => source, :skipped_lines => skipped_lines)
-    end
-
-    def create_index_for_node(node, template)
-      Haml::Engine.new(template).render(self, :node => node)
-    end    
-
-    def <<(source)
-      filename = File.basename(source.filename)
-      if source.package
-        tree.insert("/#{source.package.name}/#{filename}", source)
-      else
-        tree.insert("/#{filename}", source)
-      end
-      self
-    end
-
-    def tree
-      @tree ||= Tree.new
-    end
-
-    def current_scope
-      @current_scope ||= default_scope
-    end
-
-    def default_scope
-      ["/**/*"]
-    end
-
-    def current_scope=(scope)
-      @current_scope = scope
-    end
-
-    # exclusive scope
-    def only(scope)
-      result = clone
-      result.current_scope = [scope].flatten
-      result
-    end
-
-    # additive scope
-    def or(scope)
-      result = clone
-      result.current_scope = current_scope + [scope].flatten
-      result
-    end
-
-    def documented_sources
-      @documented_sources ||= documented_sources!
-    end
-
-    def documented_sources!
-      doctree = Tree.new
-      current_scope.map {|pathspec| tree.glob(pathspec) }.flatten.each {|s| doctree.insert(s.full_path, s.value)}
-      doctree
-    end
-
-    protected
-    def file_from_contents(filename, contents)
-      File.open(filename, "w+") {|f| f << contents }
-    end
-  end
-end