docjs 0.1

data/test/rspec_helper.rb

@@ -0,0 +1,23 @@
+def should_raise(exception_type, &block)    
+  begin
+    block.call    
+    raise RSpec::Expectations::ExpectationNotMetError
+  rescue Exception => e
+    e.class.should == exception_type
+  end    
+end
+
+class Object
+
+  def should_be_named_typed_token(name, types, content)
+    self.name.should == name
+    self.types.should == types
+    self.content.should == content
+  end
+  
+  def should_be_typed_token(types, content)
+    self.types.should == types
+    self.content.should == content
+  end
+  
+end

data/test/token/handler.rb

@@ -0,0 +1,136 @@
+# ../data.img#1771563:1
+require_relative '../../lib/parser/comment'
+require_relative '../../lib/code_object/function'
+
+describe Token::Handler, ".register" do
+  
+  before :each do
+    Token::Handler.unregister :test_handler
+    @object = CodeObject::Function.new
+  end
+  
+  after :all do
+    Token::Handler.unregister :test_handler
+  end
+
+  
+  context "using a default handler" do    
+  
+    before do 
+      Token::Handler.register :test_handler
+      token = Parser::Tokenline.new :test_handler, "This is some content"
+      @object.process_token(token)
+    end
+    
+    describe "the processed token" do
+      subject { @object.token(:test_handler).first }
+      
+      it "should have got the correct content" do
+        subject.content.should == "This is some content"
+      end      
+    end
+       
+  end
+
+
+  context "using a typed handler" do    
+  
+    before do 
+      Token::Handler.register :test_handler, :typed
+      token = Parser::Tokenline.new :test_handler, "[MyType] This is some content"
+      @object.process_token(token)
+    end
+    
+    describe "the processed token" do
+      subject { @object.token(:test_handler).first }
+      
+      it "should have got correct type and content" do 
+        subject.types.should == ["MyType"]
+        subject.content.should == "This is some content"
+      end
+    end
+        
+  end
+
+
+  context "using a typed_with_name handler" do    
+  
+    before do 
+      Token::Handler.register :test_handler, :typed_with_name
+      token = Parser::Tokenline.new :test_handler, "[Foo, Bar, Baz] MyName This is some content"
+      @object.process_token(token)
+    end
+    
+    describe "the processed token" do
+      subject { @object.token(:test_handler).first }
+      
+      it "should have got correct typedname and content" do 
+        subject.types.should == ["Foo", "Bar", "Baz"]
+        subject.name.should == "MyName"
+        subject.content.should == "This is some content"
+      end
+    end
+        
+  end
+
+  
+  context "processing a token without handler" do
+    
+    token = Parser::Tokenline.new :test_handler, "[Foo, Bar, Baz] MyName This is some content"
+    
+    it "should raise an error" do
+      should_raise Token::NoTokenHandler do
+        @object.process_token(token)
+      end
+    end 
+       
+  end
+  
+  
+  context "multiple tokens of the same type" do
+  
+    before do
+      Token::Handler.register :test_handler
+      @object.process_token Parser::Tokenline.new :test_handler, "This is some content"
+      @object.process_token Parser::Tokenline.new :test_handler, "And another one"
+      @object.process_token Parser::Tokenline.new :test_handler, "Third content"
+    end
+    
+    subject { @object.token(:test_handler) }
+    
+    it "should be processed to an array" do
+      subject.length.should == 3
+      subject[0].content.should == "This is some content"
+      subject[1].content.should == "And another one"
+      subject[2].content.should == "Third content"
+    end
+      
+  end
+  
+  
+  context "using a user-defined block as token-handler" do
+    
+    before do
+      Token::Handler.register(:test_handler) do |token, content|
+        define_singleton_method :test_token do 
+          token
+        end
+        
+        define_singleton_method :test_content do 
+          content
+        end
+      end
+      @object.process_token Parser::Tokenline.new :test_handler, "This is some content"
+    end
+    
+    it "should be added to the list of handlers" do
+      Token::Handler.handlers.include?(:test_handler).should == true
+    end
+    
+    it "should be evaled in CodeObject context" do
+      @object.test_token.should == :test_handler
+      @object.test_content.should == "This is some content"
+    end
+    
+  end
+end

data/test/token/tokens.rb

@@ -0,0 +1,52 @@
+require_relative '../../lib/parser/comment'
+require_relative '../../lib/code_object/function'
+require_relative '../../lib/token/tokens'
+
+describe Token::Handler, ".register" do
+  
+  before :each do
+    @object = CodeObject::Function.new
+  end
+  
+  context "token @example with name" do
+  
+    before do 
+      @object.process_token(Parser::Tokenline.new(:example, "MyName \nThis is a multiline \nCodeexample."))
+    end
+    
+    describe "the token" do
+      
+      subject { @object.tokens[:example].first }
+    
+      it "should have a correct name" do
+        subject.name.should == "MyName"
+      end    
+      
+      it "should have correct content" do
+        subject.content.should == "This is a multiline \nCodeexample."
+      end
+    end    
+  end
+  
+  
+  context "token @example without name" do
+  
+    before do 
+      @object.process_token(Parser::Tokenline.new(:example, "\nThis is a multiline \nCodeexample."))
+    end
+    
+    describe "the token" do
+      
+      subject { @object.tokens[:example].first }
+    
+      it "should have empty name" do
+        subject.name.should == ""
+      end    
+      
+      it "should have correct content" do
+        subject.content.should == "This is a multiline \nCodeexample."
+      end
+    end    
+  end
+end
+

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification 
+name: docjs
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Jonathan Brachth\xC3\xA4user"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-07 00:00:00 +02:00
+default_executable: bin/docjs
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Create beautyful Javascript documentations with this ruby-gem. It's pretty easy to customize and add your own tokens/DSL.
+email: jonathan@b-studios.de
+executables: 
+- docjs
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CONCEPT.md
+- DOCUMENTATION.md
+- LICENSE.md
+- README.md
+- RENDERING.md
+- bin/docjs
+- docjs.gemspec
+- lib/boot.rb
+- lib/code_object/base.rb
+- lib/code_object/converter.rb
+- lib/code_object/exceptions.rb
+- lib/code_object/function.rb
+- lib/code_object/object.rb
+- lib/code_object/type.rb
+- lib/configs.rb
+- lib/document/document.rb
+- lib/dom/dom.rb
+- lib/dom/exceptions.rb
+- lib/dom/no_doc.rb
+- lib/dom/node.rb
+- lib/helper/helper.rb
+- lib/helper/linker.rb
+- lib/logger.rb
+- lib/parser/comment.rb
+- lib/parser/comment_parser.rb
+- lib/parser/exceptions.rb
+- lib/parser/meta_container.rb
+- lib/parser/parser.rb
+- lib/processor.rb
+- lib/renderer.rb
+- lib/tasks/render_task.rb
+- lib/thor.rb
+- lib/token/container.rb
+- lib/token/exceptions.rb
+- lib/token/handler.rb
+- lib/token/token.rb
+- templates/application.rb
+- templates/helpers/template.rb
+- templates/resources/css/.sass-cache/98c121fba905284c2c8ca6220fe3c590e5c9ec19/application.scssc
+- templates/resources/css/application.css
+- templates/resources/img/arrow_down.png
+- templates/resources/img/arrow_right.png
+- templates/resources/img/arrow_up.png
+- templates/resources/img/bullet_toggle_minus.png
+- templates/resources/img/bullet_toggle_plus.png
+- templates/resources/img/constructor.png
+- templates/resources/img/function.png
+- templates/resources/img/object.png
+- templates/resources/img/page.png
+- templates/resources/img/prototype.png
+- templates/resources/img/tag.png
+- templates/resources/js/application.js
+- templates/resources/js/jcore.js
+- templates/resources/js/jquery.cookie.js
+- templates/resources/js/jquery.js
+- templates/resources/js/jquery.tooltip.js
+- templates/resources/js/jquery.treeview.js
+- templates/resources/scss/_footer.scss
+- templates/resources/scss/_header.scss
+- templates/resources/scss/_helpers.scss
+- templates/resources/scss/_print.scss
+- templates/resources/scss/_resets.scss
+- templates/resources/scss/_tooltip.scss
+- templates/resources/scss/application.scss
+- templates/tasks/api_index_task.rb
+- templates/tasks/docs_task.rb
+- templates/tasks/json_data_task.rb
+- templates/tasks/typed_task.rb
+- templates/tokens/tokens.rb
+- templates/types/prototype.rb
+- templates/views/api_index.html.erb
+- templates/views/doc_page.html.erb
+- templates/views/function/_detail.html.erb
+- templates/views/function/index.html.erb
+- templates/views/index.html.erb
+- templates/views/layout/application.html.erb
+- templates/views/layout/json.html.erb
+- templates/views/object/index.html.erb
+- templates/views/tokens/_default.html.erb
+- templates/views/tokens/_default_token.html.erb
+- templates/views/tokens/_example.html.erb
+- templates/views/tokens/_examples.html.erb
+- test/code_object/converter.rb
+- test/code_object/prototype.rb
+- test/configs.rb
+- test/docs/README.CONCEPT.md
+- test/docs/README.md
+- test/dom/dom.absolute_nodes.rb
+- test/dom/dom.rb
+- test/dom/node.rb
+- test/integration/converter.rb
+- test/integration/parser_factory.rb
+- test/interactive.rb
+- test/js-files/absolute.js
+- test/js-files/comments_in_strings.js
+- test/js-files/core-doc-relative.js
+- test/js-files/core-doc.js
+- test/js-files/nested.js
+- test/js-files/nested_with_strings.js
+- test/js-files/prototype.js
+- test/js-files/simple.js
+- test/js-files/tokens.js
+- test/parser/comments_in_strings.rb
+- test/parser/intelligent_skip_until.rb
+- test/parser/parser.rb
+- test/rspec_helper.rb
+- test/token/handler.rb
+- test/token/tokens.rb
+has_rdoc: true
+homepage: https://github.com/b-studios/docjs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.5"
+requirements: []
+
+rubyforge_project: docjs
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Javascript Documentation Generator
+test_files: []
+