docjs 0.1.4 → 0.1.5

data/lib/token/token.rb

@@ -1,17 +1,49 @@
 module Token
+
+  # Serves as Base-Class for all registered tokens.
+  # Registering a token with 
+  #     
+  #     Token:Handler.register :awesome, :template => :foo, :description => "Description"
+  #
+  # is pretty much equivalent to
+  #
+  #     class Token::AwesomeToken < Token::Token; end
+  #     Token::AwesomeToken.process_options({ 
+  #       :token       => :awesome,
+  #       :template    => :foo,
+  #       :description => "Description" 
+  #     })
   class Token
 
     attr_reader :name, :content, :types, :children
     
-    def initialize(args = {})
-    
+    def initialize(args = {})    
       @name = args[:name]
       @types = args[:types]
       @children = args[:children]      
       @content = args[:content] || ""
     end    
     
-    # @note should only be performed once!!!
+    # Processes the options, which are added while registering the new token-handler
+    #
+    #     Token:Handler.register :awesome, :template => :foo, :description => "Description"
+    # 
+    # This will create a class Token::AwesomeToken, which extends {Token::Token}. After creating the class
+    # {.process_options} will be called with all provided options to apply those to the class.
+    #
+    # Because the options are valid for all instances of a tokenclass, the contents are stored in 
+    # class-variables and class-methods are defined as accessors:
+    #
+    # - handler
+    # - token
+    # - template
+    # - html
+    # - area
+    # - description
+    #
+    # Further information about this options can be found at {Token::Handler.register}
+    #
+    # @note Because class-methods are defined in this method, it should only be performed once!!!
     def self.process_options(options = {})
     
       # pushing defaults

data/templates/application.rb

@@ -1,4 +1,6 @@
 # Load CodeObject::Types
+require_relative 'types/object'
+require_relative 'types/function'
 require_relative 'types/prototype'
 
 # Load Default Tokens
@@ -7,8 +9,8 @@ require_relative 'tokens/tokens'
 # Load Helpers
 require_relative 'helpers/template'
 
-# Load Rendertasks
-require_relative 'tasks/typed_task'
-require_relative 'tasks/docs_task'
-require_relative 'tasks/api_index_task'
-require_relative 'tasks/json_data_task'
+# Load Generators
+require_relative 'generators/api_pages_generator'
+require_relative 'generators/docs_generator'
+require_relative 'generators/api_index_generator'
+require_relative 'generators/json_generator'

data/templates/{tasks/api_index_task.rb → generators/api_index_generator.rb}

@@ -1,6 +1,6 @@
-module Tasks
+module Generator
 
-  class ApiIndexTask < RenderTask
+  class ApiIndexGenerator < Generator
 
     describe     'renders the api_index.html file containing all documented elements as alphabetic listing'
     layout       'application'

data/templates/{tasks/typed_task.rb → generators/api_pages_generator.rb}

@@ -1,6 +1,6 @@
-module Tasks
+module Generator
 
-  class TypedTask < RenderTask
+  class ApiPagesGenerator < Generator
 
     # @todo those methods and therefore all class-variables @@configs are shared with all inheriting
     #   classes. i.e. The last change will be applied to all

data/templates/{tasks/docs_task.rb → generators/docs_generator.rb}

@@ -1,6 +1,6 @@
-module Tasks
+module Generator
 
-  class DocsTask < RenderTask
+  class DocsGenerator < Generator
   
     describe     'renders all specified Markdown files to static documentation'
     layout       'application'
@@ -15,6 +15,13 @@ module Tasks
                
         render_document doc        
       end
+      
+      
+      readme = Dom.docs.find('README')
+      in_context readme do
+        @document = readme
+        render 'doc_page', :to_file => "index.html"
+      end unless readme.nil?
     end
 
     def render_document(document)       

data/templates/{tasks/json_data_task.rb → generators/json_generator.rb}

@@ -1,6 +1,6 @@
-module Tasks
+module Generator
 
-  class JsonDataTask < RenderTask
+  class JsonGenerator < Generator
 
     describe     'renders all documented objects to a json file. Objects and Functions are handled seperatly'
     layout       nil

data/templates/tokens/tokens.rb

@@ -5,14 +5,14 @@ module Token::Handler
   register :private, :area => :sidebar
   register :version, :area => :sidebar
   
-  register :see, :area => :footer
+  register :see, :area => :footnote
 
   register :deprecated, :area => :notification  
   register :todo, :area => :notification
   register :note, :area => :notification
   register :warn, :area => :notification
   
-  register :example, :template => 'examples', :handler => :named_multiline
+  register :example, :template => :examples, :handler => :named_multiline
    
   # Every @overload can contain **text-documentation**, **@param**- and **@return**-tokens
   #

data/{lib/code_object → templates/types}/function.rb

@@ -1,5 +1,3 @@
-require_relative 'object'
-
 module CodeObject
 
   class Function < CodeObject::Object
@@ -16,6 +14,10 @@ module CodeObject
       children[:prototype]
     end
   
+    def display_name
+      @name + '()'
+    end
+    
   end 
   
 end
@@ -56,6 +58,6 @@ Token::Handler.register :throws, :handler => :typed
 class CodeObject::Method < CodeObject::Function; end
 Token::Handler.register :method, :handler => :noop, :area => :none
 
-# @constructor Foo.bar
+# ConstructorAlias
 class CodeObject::Constructor < CodeObject::Function; end
 Token::Handler.register(:constructor) { |token, content| @constructor = true }

data/{lib/code_object → templates/types}/object.rb

@@ -1,5 +1,3 @@
-require_relative 'base'
-
 module CodeObject
 
   class Object < CodeObject::Base

data/templates/types/prototype.rb

@@ -1,8 +1,7 @@
 class CodeObject::Prototype < CodeObject::Object
   
-  def initialize(*args)
-    super(*args)
-    @path += '.prototype'
+  def initialize(path)
+    super(path.strip + '.prototype')
   end
   
   # get the constructor, for which this prototype is used

data/templates/views/tokens/_default.html.erb

@@ -1,6 +1,4 @@
 <% unless tokens.nil? 
-
-
   opts = tokens.first.html
   opts[:class] = (opts[:class] || "") + " subsection"
 %>

data/test/code_object/prototype.rb

@@ -1,6 +1,6 @@
 # ../data.img#1774507:1
 require_relative '../../lib/boot'
-require_relative '../../templates/types/prototype'
+require_relative '../../templates/application'
 
 describe CodeObject::Prototype, ".new" do
 

data/test/dom/dom.absolute_nodes.rb

@@ -1,6 +1,5 @@
-require_relative '../../lib/dom/dom'
-require_relative '../../lib/code_object/function'
-require_relative '../../lib/processor'
+require_relative '../../lib/boot'
+require_relative '../../templates/application'
 
 describe Dom, ".add_child" do
   

data/test/dom/dom.rb

@@ -1,13 +1,13 @@
 # ../data.img#1811393:1
 require_relative '../../lib/dom/dom'
-require_relative '../../lib/code_object/function'
+require_relative '../../lib/code_object/base'
 
 describe Dom, ".add_child" do
 
   before do
     Dom.clear
-    @o1 = CodeObject::Object.new
-    @o2 = CodeObject::Object.new
+    @o1 = CodeObject::Base.new
+    @o2 = CodeObject::Base.new
   end
   
   it "should add absolute nodes" do

data/test/dom/node.rb

@@ -1,15 +1,15 @@
 # ../data.img#1772233:1
 require_relative '../../lib/dom/dom'
-require_relative '../../lib/code_object/function'
+require_relative '../../lib/code_object/base'
 
 describe Dom::Node, "#resolve" do
 
   before do
     Dom.clear
-    @o1 = CodeObject::Object.new 
-    @o2 = CodeObject::Object.new
-    @o3 = CodeObject::Object.new
-    @o4 = CodeObject::Object.new
+    @o1 = CodeObject::Base.new 
+    @o2 = CodeObject::Base.new
+    @o3 = CodeObject::Base.new
+    @o4 = CodeObject::Base.new
     
     Dom.add_node "Foo.bar" , @o1
     @o1.add_node ".baz"    , @o2  
@@ -33,10 +33,10 @@ describe Dom::Node, "#qualified_name" do
 
   before do
     Dom.clear
-    @o1 = CodeObject::Object.new "bar"
-    @o2 = CodeObject::Object.new "baz"
-    @o3 = CodeObject::Object.new "bam"
-    @o4 = CodeObject::Object.new "poo"
+    @o1 = CodeObject::Base.new "bar"
+    @o2 = CodeObject::Base.new "baz"
+    @o3 = CodeObject::Base.new "bam"
+    @o4 = CodeObject::Base.new "poo"
     
     Dom.add_node "Foo.bar" , @o1
     @o1.add_node ".baz"    , @o2  

data/test/integration/converter.rb

@@ -21,7 +21,7 @@ describe CodeObject::Converter, "#to_code_object" do
       subject { @objects[0] }
       
       it "should be a function named 'say_hello'" do
-        subject.class.should == CodeObject::Function
+        subject.is_a?(CodeObject::Function).should == true
         subject.name.should == "say_hello"
       end
       
@@ -45,7 +45,7 @@ describe CodeObject::Converter, "#to_code_object" do
       subject { @objects[1] }
     
       it "should be an Object named 'FOO'" do
-        subject.class.should == CodeObject::Object
+        subject.is_a?(CodeObject::Object).should == true
         subject.name.should == "FOO"
       end    
     end
@@ -54,7 +54,7 @@ describe CodeObject::Converter, "#to_code_object" do
       subject { @objects[2] }
     
       it "should be an Function named 'some_function'" do
-        subject.class.should == CodeObject::Function
+        subject.is_a?(CodeObject::Function).should == true
         subject.name.should == "some_function"
       end
       

data/test/token/handler.rb

@@ -1,6 +1,9 @@
 # ../data.img#1771563:1
 require_relative '../../lib/parser/comment'
-require_relative '../../lib/code_object/function'
+require_relative '../../templates/types/function'
+
+# Warning! This Tests have some sideeffects. All registered Tokens will create Classes, that are not
+# removed on unregister
 
 describe Token::Handler, ".register" do
   
@@ -36,7 +39,7 @@ describe Token::Handler, ".register" do
   context "using a typed handler" do    
   
     before do 
-      Token::Handler.register :test_handler, :typed
+      Token::Handler.register :test_handler, :handler => :typed
       token = Parser::Tokenline.new :test_handler, "[MyType] This is some content"
       @object.process_token(token)
     end
@@ -56,7 +59,7 @@ describe Token::Handler, ".register" do
   context "using a typed_with_name handler" do    
   
     before do 
-      Token::Handler.register :test_handler, :typed_with_name
+      Token::Handler.register :test_handler, :handler => :typed_with_name
       token = Parser::Tokenline.new :test_handler, "[Foo, Bar, Baz] MyName This is some content"
       @object.process_token(token)
     end
@@ -76,7 +79,7 @@ describe Token::Handler, ".register" do
   
   context "processing a token without handler" do
     
-    token = Parser::Tokenline.new :test_handler, "[Foo, Bar, Baz] MyName This is some content"
+    token = Parser::Tokenline.new :some_not_known_handler, "[Foo, Bar, Baz] MyName This is some content"
     
     it "should raise an error" do
       should_raise Token::NoTokenHandler do
@@ -111,24 +114,24 @@ describe Token::Handler, ".register" do
   context "using a user-defined block as token-handler" do
     
     before do
-      Token::Handler.register(:test_handler) do |token, content|
+      Token::Handler.register(:test) do |tokenklass, content|
         define_singleton_method :test_token do 
-          token
+          tokenklass
         end
         
         define_singleton_method :test_content do 
           content
         end
       end
-      @object.process_token Parser::Tokenline.new :test_handler, "This is some content"
+      @object.process_token Parser::Tokenline.new :test, "This is some content"
     end
     
     it "should be added to the list of handlers" do
-      Token::Handler.handlers.include?(:test_handler).should == true
+      Token::Handler.handlers.include?(:test).should == true
     end
     
     it "should be evaled in CodeObject context" do
-      @object.test_token.should == :test_handler
+      @object.test_token.should == Token::Token::TestToken
       @object.test_content.should == "This is some content"
     end
     

data/test/token/tokens.rb

@@ -1,5 +1,5 @@
 require_relative '../../lib/parser/comment'
-require_relative '../../lib/code_object/function'
+require_relative '../../templates/types/function'
 
 require_relative '../../templates/tokens/tokens'
 

metadata

@@ -2,7 +2,7 @@
 name: docjs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - "Jonathan Brachth\xC3\xA4user"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 +02:00
+date: 2011-06-25 00:00:00 +02:00
 default_executable: bin/docjs
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,26 +44,29 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- CONCEPT.md
-- DOCUMENTATION.md
 - LICENSE.md
 - README.md
-- RENDERING.md
 - bin/docjs
 - bin/docjs.rb
 - docjs.gemspec
+- docs/ARCHITECTURE.md
+- docs/CONCEPT.md
+- docs/DOCUMENTATION.md
+- docs/PATTERNS.md
+- docs/guides/CUSTOMIZE.md
+- docs/guides/TRY.md
+- docs/guides/USE.md
 - 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/configs.rb
 - lib/document/document.rb
 - lib/dom/dom.rb
 - lib/dom/exceptions.rb
 - lib/dom/no_doc.rb
 - lib/dom/node.rb
+- lib/generator/generator.rb
 - lib/helper/helper.rb
 - lib/helper/linker.rb
 - lib/logger.rb
@@ -74,13 +77,16 @@ files:
 - 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/generators/api_index_generator.rb
+- templates/generators/api_pages_generator.rb
+- templates/generators/docs_generator.rb
+- templates/generators/json_generator.rb
 - templates/helpers/template.rb
 - templates/resources/css/.sass-cache/98c121fba905284c2c8ca6220fe3c590e5c9ec19/application.scssc
 - templates/resources/css/application.css
@@ -112,11 +118,9 @@ files:
 - 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/function.rb
+- templates/types/object.rb
 - templates/types/prototype.rb
 - templates/views/api_index.html.erb
 - templates/views/doc_page.html.erb