docjs 0.1.3 → 0.1.4

data/bin/docjs

@@ -23,9 +23,7 @@ Configs.set :root  => Pathname.new(__FILE__).realpath + '../..'
 #   4. turn into objects and save to dom
 #   5. render templates
 #
-# @note options declared in a build.yml will override command-line ones
-# @todo command line option to copy all templates to specified directory like
-#   jsdoc dump_templates ../templates/original
+# @note options declared in a docjs.yml will override command-line ones
 class DocJs < Thor
     
   include Thor::Actions
@@ -51,118 +49,45 @@ class DocJs < Thor
                   
               :loglevel =>
                   { :type => :string, :aliases => '-ll', :default => 'info' }
-  
   def docjs(config_file = nil)
+    
+    # Process the given command-line and yml-options
     # @see Thor#merge_options
     configs = config_file ? merge_options(options, config_file) : options
     
     begin
+      # Setup Logger and Configs
       setup_application configs
       
-      # load application specific files
-      Logger.debug "Loading application-templates: #{Configs.templates + '/application.rb'}"
-      require Configs.templates + '/application.rb'
+      # Load application specific files
+      Logger.info "Loading Application-Templates"
+      load_templates
       
-      # Config Thor settings
+      # Config Thor path-settings
       DocJs.source_root(Configs.templates)
       self.destination_root = Configs.output
       
+      # Process specified docs and add them to dom-tree
       Processor.prepare_documents
-      # let's check our Documents tree
-      Dom.docs.print_tree
       
-      # the configs are now available through our Configs-module      
+      # Kickoff js-file-processing and template-rendering!
       Processor.process_and_render
         
+      # Finally copy all
       Logger.info "Copying template resources to output"
       directory 'resources/img', './img' # copy resources
       directory 'resources/css', './css'
       directory 'resources/js', './js'
-            
+      
     rescue Exception => error
       Logger.error error.message + "\n" + error.backtrace.map{|l| "  #{l}" }.join("\n")
     end    
   end  
-    
-    
-    
-  desc "tokens TEMPLATE_PATH?", "Lists all supported tokens\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
-  set_options :details => 
-                 { :type => :boolean, :default => false }
-  def tokens(template_path = nil)
-  
-    unless template_path.nil?
-      require File.absolute_path(template_path) + '/application.rb'
-    else
-      require Configs.root + 'templates/application.rb'
-    end
-  
-    say "Supported tokens:\n\n"
-    if options.details?
-      table = [%w(TOKEN AREA TEMPLATE DESCRIPTION)] + Token::Handler.handlers.map{|k,v| [":#{k}",v.area, v.template, v.description] }.sort
-    else
-      table = Token::Handler.handlers.map{|k,v| [":#{k}","# #{v.description}"] }.sort
-    end
-    print_table table, :ident => 2, :colwidth => 20
-  end
-  
-  
-  
-  desc "tasks TEMPLATE_PATH?", "Lists all registered render-tasks\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
-  def tasks(template_path = nil)
-    unless template_path.nil?
-      require File.absolute_path(template_path) + '/application.rb'
-    else
-      require Configs.root + 'templates/application.rb'
-    end
-    
-    say "Registered render-tasks:"
-    
-    task_table = Processor.render_tasks.map{|k,v| [":#{k}","# #{v.description}"] }.sort
-    
-    print_table task_table, :ident => 2, :colwidth => 20    
-  end  
-  
-  
-  
-  desc "scaffold OUTPUT_DIR", "You can use scaffolding to get the templates and some basic ruby-files, that you will need to create your own templates"
-  set_options :logfile =>
-                  { :type => :string, :aliases => '-lf', :default => 'jsdoc.log' },
-                  
-              :loglevel =>
-                  { :type => :string, :aliases => '-ll', :default => 'info' }
-  def scaffold(output_dir)
-      
-    setup_application options.merge({
-      :output => output_dir,
-      :templates => output_dir
-    })
-    
-    # Setup Thor paths
-    DocJs.source_root(Configs.root)
-    self.destination_root = Configs.output
 
-    yes_no = "(y|n)"
-    
-    Logger.info "We need some information from you, to customize the scaffolding process to your needs."    
-    if yes? "Do you wan't to generate a build.yml? #{yes_no}"
-      configure(Configs.wdir + '/build.yml', {
-        'templates' => output_dir,
-        'output'    => 'docs',
-        'logfile'   => 'logfile.log',
-        'loglevel'  => 'info'
-      })
-    end
-        
-    # Work with the answers    
-    Logger.info "Copying the template files to #{Configs.templates}"
-    directory 'templates', Configs.templates    # copy templates and resources
-        
-    Logger.info "Copying the included *.rb files to #{Configs.includes}"    
-  end
+
   
-  desc "configure [NEW_CONFIGFILE]", "Helps you creating your build.yml to start off with doc.js"
-  def configure(output_file = "build.yml", preconfigured = {})
+  desc "configure [NEW_CONFIGFILE]", "Helps you creating your docjs.yml to start off with doc.js"
+  def configure(output_file = "docjs.yml", preconfigured = {})
     
     build = {
       'files'     => [],
@@ -225,8 +150,76 @@ class DocJs < Thor
     # maybe ask some more information to generate build.yml
     create_file output_file, build.to_yaml
   end
+
+
+  
+  desc "scaffold OUTPUT_DIR", "You can use scaffolding to get the templates and some basic ruby-files, that you will need to create your own templates"
+  set_options :logfile =>
+                  { :type => :string, :aliases => '-lf', :default => 'jsdoc.log' },
+                  
+              :loglevel =>
+                  { :type => :string, :aliases => '-ll', :default => 'info' }
+  def scaffold(output_dir)
+      
+    setup_application options.merge({
+      :output => output_dir,
+      :templates => output_dir
+    })
+    
+    # Setup Thor paths
+    DocJs.source_root(Configs.root)
+    self.destination_root = Configs.output
+
+    yes_no = "(y|n)"
+    
+    Logger.info "We need some information from you, to customize the scaffolding process to your needs."    
+    if yes? "Do you wan't to generate a docjs.yml? #{yes_no}"
+      configure(Configs.wdir + '/docjs.yml', {
+        'templates' => output_dir,
+        'output'    => 'docs',
+        'logfile'   => 'logfile.log',
+        'loglevel'  => 'info'
+      })
+    end
+        
+    # Work with the answers    
+    Logger.info "Copying the template files to #{Configs.templates}"
+    directory 'templates', Configs.templates    # copy templates and resources
+        
+    Logger.info "Copying the included *.rb files to #{Configs.includes}"    
+  end
   
   
+
+  desc "tokens TEMPLATE_PATH?", "Lists all supported tokens\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
+  set_options :details => 
+                 { :type => :boolean, :default => false }
+  def tokens(template_path = nil)
+  
+    load_templates template_path
+  
+    say "Supported tokens:\n\n"
+    if options.details?
+      table = [%w(TOKEN AREA TEMPLATE DESCRIPTION)] + Token::Handler.handlers.map{|k,v| [":#{k}",v.area, v.template, v.description] }.sort
+    else
+      table = Token::Handler.handlers.map{|k,v| [":#{k}","# #{v.description}"] }.sort
+    end
+    print_table table, :ident => 2, :colwidth => 20
+  end
+  
+  
+  
+  desc "tasks TEMPLATE_PATH?", "Lists all registered render-tasks\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
+  def tasks(template_path = nil)
+    
+    load_templates template_path
+    
+    say "Registered render-tasks:"
+    
+    task_table = Tasks::RenderTask.all.map{|task| ["#{task.name}","# #{task.description}"] }.sort
+    
+    print_table task_table, :ident => 2, :colwidth => 20    
+  end 
 end
 
 if ARGV.size == 0
@@ -236,4 +229,4 @@ elsif not (ARGV.size > 0 and DocJs.method_defined?(ARGV.first))
   ARGV.unshift 'docjs'
 end
 
-DocJs.start(ARGV)
+DocJs.start(ARGV)

data/bin/docjs.rb

@@ -23,9 +23,7 @@ Configs.set :root  => Pathname.new(__FILE__).realpath + '../..'
 #   4. turn into objects and save to dom
 #   5. render templates
 #
-# @note options declared in a build.yml will override command-line ones
-# @todo command line option to copy all templates to specified directory like
-#   jsdoc dump_templates ../templates/original
+# @note options declared in a docjs.yml will override command-line ones
 class DocJs < Thor
     
   include Thor::Actions
@@ -51,118 +49,45 @@ class DocJs < Thor
                   
               :loglevel =>
                   { :type => :string, :aliases => '-ll', :default => 'info' }
-  
   def docjs(config_file = nil)
+    
+    # Process the given command-line and yml-options
     # @see Thor#merge_options
     configs = config_file ? merge_options(options, config_file) : options
     
     begin
+      # Setup Logger and Configs
       setup_application configs
       
-      # load application specific files
-      Logger.debug "Loading application-templates: #{Configs.templates + '/application.rb'}"
-      require Configs.templates + '/application.rb'
+      # Load application specific files
+      Logger.info "Loading Application-Templates"
+      load_templates
       
-      # Config Thor settings
+      # Config Thor path-settings
       DocJs.source_root(Configs.templates)
       self.destination_root = Configs.output
       
+      # Process specified docs and add them to dom-tree
       Processor.prepare_documents
-      # let's check our Documents tree
-      Dom.docs.print_tree
       
-      # the configs are now available through our Configs-module      
+      # Kickoff js-file-processing and template-rendering!
       Processor.process_and_render
         
+      # Finally copy all
       Logger.info "Copying template resources to output"
       directory 'resources/img', './img' # copy resources
       directory 'resources/css', './css'
       directory 'resources/js', './js'
-            
+      
     rescue Exception => error
       Logger.error error.message + "\n" + error.backtrace.map{|l| "  #{l}" }.join("\n")
     end    
   end  
-    
-    
-    
-  desc "tokens TEMPLATE_PATH?", "Lists all supported tokens\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
-  set_options :details => 
-                 { :type => :boolean, :default => false }
-  def tokens(template_path = nil)
-  
-    unless template_path.nil?
-      require File.absolute_path(template_path) + '/application.rb'
-    else
-      require Configs.root + 'templates/application.rb'
-    end
-  
-    say "Supported tokens:\n\n"
-    if options.details?
-      table = [%w(TOKEN AREA TEMPLATE DESCRIPTION)] + Token::Handler.handlers.map{|k,v| [":#{k}",v.area, v.template, v.description] }.sort
-    else
-      table = Token::Handler.handlers.map{|k,v| [":#{k}","# #{v.description}"] }.sort
-    end
-    print_table table, :ident => 2, :colwidth => 20
-  end
-  
-  
-  
-  desc "tasks TEMPLATE_PATH?", "Lists all registered render-tasks\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
-  def tasks(template_path = nil)
-    unless template_path.nil?
-      require File.absolute_path(template_path) + '/application.rb'
-    else
-      require Configs.root + 'templates/application.rb'
-    end
-    
-    say "Registered render-tasks:"
-    
-    task_table = Processor.render_tasks.map{|k,v| [":#{k}","# #{v.description}"] }.sort
-    
-    print_table task_table, :ident => 2, :colwidth => 20    
-  end  
-  
-  
-  
-  desc "scaffold OUTPUT_DIR", "You can use scaffolding to get the templates and some basic ruby-files, that you will need to create your own templates"
-  set_options :logfile =>
-                  { :type => :string, :aliases => '-lf', :default => 'jsdoc.log' },
-                  
-              :loglevel =>
-                  { :type => :string, :aliases => '-ll', :default => 'info' }
-  def scaffold(output_dir)
-      
-    setup_application options.merge({
-      :output => output_dir,
-      :templates => output_dir
-    })
-    
-    # Setup Thor paths
-    DocJs.source_root(Configs.root)
-    self.destination_root = Configs.output
 
-    yes_no = "(y|n)"
-    
-    Logger.info "We need some information from you, to customize the scaffolding process to your needs."    
-    if yes? "Do you wan't to generate a build.yml? #{yes_no}"
-      configure(Configs.wdir + '/build.yml', {
-        'templates' => output_dir,
-        'output'    => 'docs',
-        'logfile'   => 'logfile.log',
-        'loglevel'  => 'info'
-      })
-    end
-        
-    # Work with the answers    
-    Logger.info "Copying the template files to #{Configs.templates}"
-    directory 'templates', Configs.templates    # copy templates and resources
-        
-    Logger.info "Copying the included *.rb files to #{Configs.includes}"    
-  end
+
   
-  desc "configure [NEW_CONFIGFILE]", "Helps you creating your build.yml to start off with doc.js"
-  def configure(output_file = "build.yml", preconfigured = {})
+  desc "configure [NEW_CONFIGFILE]", "Helps you creating your docjs.yml to start off with doc.js"
+  def configure(output_file = "docjs.yml", preconfigured = {})
     
     build = {
       'files'     => [],
@@ -225,8 +150,76 @@ class DocJs < Thor
     # maybe ask some more information to generate build.yml
     create_file output_file, build.to_yaml
   end
+
+
+  
+  desc "scaffold OUTPUT_DIR", "You can use scaffolding to get the templates and some basic ruby-files, that you will need to create your own templates"
+  set_options :logfile =>
+                  { :type => :string, :aliases => '-lf', :default => 'jsdoc.log' },
+                  
+              :loglevel =>
+                  { :type => :string, :aliases => '-ll', :default => 'info' }
+  def scaffold(output_dir)
+      
+    setup_application options.merge({
+      :output => output_dir,
+      :templates => output_dir
+    })
+    
+    # Setup Thor paths
+    DocJs.source_root(Configs.root)
+    self.destination_root = Configs.output
+
+    yes_no = "(y|n)"
+    
+    Logger.info "We need some information from you, to customize the scaffolding process to your needs."    
+    if yes? "Do you wan't to generate a docjs.yml? #{yes_no}"
+      configure(Configs.wdir + '/docjs.yml', {
+        'templates' => output_dir,
+        'output'    => 'docs',
+        'logfile'   => 'logfile.log',
+        'loglevel'  => 'info'
+      })
+    end
+        
+    # Work with the answers    
+    Logger.info "Copying the template files to #{Configs.templates}"
+    directory 'templates', Configs.templates    # copy templates and resources
+        
+    Logger.info "Copying the included *.rb files to #{Configs.includes}"    
+  end
   
   
+
+  desc "tokens TEMPLATE_PATH?", "Lists all supported tokens\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
+  set_options :details => 
+                 { :type => :boolean, :default => false }
+  def tokens(template_path = nil)
+  
+    load_templates template_path
+  
+    say "Supported tokens:\n\n"
+    if options.details?
+      table = [%w(TOKEN AREA TEMPLATE DESCRIPTION)] + Token::Handler.handlers.map{|k,v| [":#{k}",v.area, v.template, v.description] }.sort
+    else
+      table = Token::Handler.handlers.map{|k,v| [":#{k}","# #{v.description}"] }.sort
+    end
+    print_table table, :ident => 2, :colwidth => 20
+  end
+  
+  
+  
+  desc "tasks TEMPLATE_PATH?", "Lists all registered render-tasks\nNeeds your TEMPLATE_PATH to include your own custom tokens. If TEMPLATE_PATH is ommitted, only the default-tokens will be shown"
+  def tasks(template_path = nil)
+    
+    load_templates template_path
+    
+    say "Registered render-tasks:"
+    
+    task_table = Tasks::RenderTask.all.map{|task| ["#{task.name}","# #{task.description}"] }.sort
+    
+    print_table task_table, :ident => 2, :colwidth => 20    
+  end 
 end
 
 if ARGV.size == 0
@@ -236,4 +229,4 @@ elsif not (ARGV.size > 0 and DocJs.method_defined?(ARGV.first))
   ARGV.unshift 'docjs'
 end
 
-DocJs.start(ARGV)
+DocJs.start(ARGV)

data/docjs.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
 
 
   s.name = 'docjs'
-  s.version = '0.1.3'
-  s.date = '2011-06-16'
+  s.version = '0.1.4'
+  s.date = '2011-06-17'
   s.summary = "Javascript Documentation Generator"
   s.description = "Create beautyful Javascript documentations with this ruby-gem. It's pretty easy to customize and add your own tokens/DSL."
   s.homepage = "https://github.com/b-studios/doc.js"

data/lib/boot.rb

@@ -33,4 +33,23 @@ def setup_application(options = {})
   Logger.debug "Working Dir:   #{Configs.wdir}"
   Logger.debug "Output Dir:    #{Configs.output}"
   Logger.debug "Template Dir:  #{Configs.templates}"
+end
+
+def load_templates(template_path = nil)
+
+  if template_path.nil? and Configs.templates
+    template_path = Configs.templates
+  
+  elsif template_path.nil?
+     template_path =( Configs.root + 'templates').to_path
+  
+  else
+    template_path = File.absolute_path(template_path)
+  end
+  
+  require template_path + '/application.rb'
+  
+  # After loading all template files, we can include our default-template-helper
+  Tasks::RenderTask.use Helper::Template if Helper.const_defined? :Template
+   
 end

data/lib/code_object/base.rb

@@ -1,4 +1,3 @@
-# ../data.img#1787927:1
 require_relative '../token/container'
 require_relative '../token/handler'
 require_relative '../dom/dom'
@@ -10,6 +9,16 @@ require_relative '../parser/meta_container'
 #
 module CodeObject
 
+  # Find all CodeObject-Types, that inherit from Base
+  # @return [Hash] like {:object => CodeObject::Object, :function => CodeObject::Function }
+  def self.all_types
+    Hash[self.constants
+             .map { |c| [c.to_s.downcase.to_sym, self.const_get(c)] }
+             .select { |klass| klass[1].class == Class and klass[1].ancestors.include? Base }
+        ]
+  end  
+
+
   class Base
 
     include Token::Container
@@ -34,7 +43,7 @@ module CodeObject
     def docs=(docstring)
       @docs = docstring.strip
     end
-    
+          
     protected
     
     # This is a Helpermethod, which can be used in subclasses like CodeObject::Function

data/lib/code_object/converter.rb

@@ -1,12 +1,10 @@
-# ../data.img#1769990:1
-require_relative 'function'
 require_relative 'exceptions'
-require_relative 'type'
 
 module CodeObject
 
-
   # here the dependencies to {Dom::Node} and {Parser::Comment} should be described
+  #
+  # Converts a comment to a code_object and therefor is included in {Parser::Comment}
   module Converter
   
     attr_reader :code_object, :path
@@ -14,7 +12,7 @@ module CodeObject
     def to_code_object
 
       # 1. Create a new CodeObject from Type-Token   
-      @code_object = Type.create_matching_object(@tokenlines) or return nil
+      @code_object = find_type_for(@tokenlines) or return nil
             
       # join all documentation-contents
       @code_object.docs = @doclines.join ''     
@@ -34,7 +32,6 @@ module CodeObject
     end        
     
     protected
-
     
     # recursivly process all child-tokens
     def convert_children
@@ -43,6 +40,27 @@ module CodeObject
         yield(code_object) unless code_object.nil?
       end
     end
+        
+    
+    def find_type_for(tokenlines)
+    
+      # all_types returns a hash like {:object => CodeObject::Object ...}
+      available_types = CodeObject.all_types
     
+      types = tokenlines.select {|t| available_types.has_key? t.token }
+      
+      if types.size > 1
+        raise CodeObject::MultipleTypeDeclarations.new, "Wrong number of TypeDeclarations: #{types}"
+      elsif types.size == 0
+        # it's not possible to create instance
+        return nil
+      end
+      
+      type = types.first
+      
+      # Get Class and instantiate it with content
+      klass = available_types[type.token]
+      klass.new(type.content)
+    end    
   end
-end
+end

data/lib/code_object/function.rb

@@ -1,4 +1,3 @@
-# ../data.img#1858563:1
 require_relative 'object'
 
 module CodeObject
@@ -21,48 +20,42 @@ module CodeObject
   
 end
 
-CodeObject::Type.register :function, CodeObject::Function
-
-module Token::Handler
-
-  register :function, 
-           :handler => :noop, 
-           :area => :none,
-           :description => "Type-Token to categorize all kind of JavaScript-Functions"
-
-
-  # We want to support either named-typed-tokens like
-  #  @param [Foo] barname some description
-  #
-  # or multiline tokens like:
-  #  @param configs
-  #    Some configuration Object with following properties:
-  #    [String] foo some string
-  #    [Bar] bar and another one
-  #
-  # @note this can also be utilized for JavaScript-Event-Triggers or Callbacks with Parameters
-  register :param, :area => :none, :description => "Token for Function-Parameters like '@param [String] name your name'" do |tokenklass, content|
-
-    # it's @param [String] name some content
-    if content.lines.first.match TOKEN_W_TYPE_NAME
-      self.add_token Token::Handler.apply(:typed_with_name, Token::Token::ParamToken, content)
-    
-    # it maybe a multiline
-    else
-      self.add_token Token::Handler.apply(:named_nested_shorthand, Token::Token::ParamToken, content)
-    end   
-  end
-
-
+Token::Handler.register :function, 
+         :handler => :noop, 
+         :area => :none,
+         :description => "Type-Token to categorize all kind of JavaScript-Functions"
+
+
+# We want to support either named-typed-tokens like
+#  @param [Foo] barname some description
+#
+# or multiline tokens like:
+#  @param configs
+#    Some configuration Object with following properties:
+#    [String] foo some string
+#    [Bar] bar and another one
+#
+# @note this can also be utilized for JavaScript-Event-Triggers or Callbacks with Parameters
+Token::Handler.register :param, :area => :none, :description => "Token for Function-Parameters like '@param [String] name your name'" do |tokenklass, content|
+
+  # it's @param [String] name some content
+  if content.lines.first.match Token::Handler::TOKEN_W_TYPE_NAME
+    self.add_token Token::Handler.apply(:typed_with_name, Token::Token::ParamToken, content)
+  
+  # it maybe a multiline
+  else
+    self.add_token Token::Handler.apply(:named_nested_shorthand, Token::Token::ParamToken, content)
+  end   
 end
 
+
 Token::Handler.register :return, :handler => :typed, :area => :none, :description => "Returnvalue of a Function"
 Token::Handler.register :throws, :handler => :typed
 
 # MethodAlias
-CodeObject::Type.register :method, CodeObject::Function
+class CodeObject::Method < CodeObject::Function; end
 Token::Handler.register :method, :handler => :noop, :area => :none
 
 # @constructor Foo.bar
-CodeObject::Type.register :constructor, CodeObject::Function
+class CodeObject::Constructor < CodeObject::Function; end
 Token::Handler.register(:constructor) { |token, content| @constructor = true }

data/lib/code_object/object.rb

@@ -1,6 +1,4 @@
-# ../data.img#1858561:1
 require_relative 'base'
-require_relative 'type'
 
 module CodeObject
 
@@ -12,7 +10,5 @@ module CodeObject
     
 end
 
-CodeObject::Type.register :object, CodeObject::Object
 Token::Handler.register :object, :handler => :noop, :area => :none
-
 Token::Handler.register :prop, :handler => :typed_with_name

data/lib/dom/dom.rb

@@ -1,4 +1,3 @@
-# ../data.img#1811391:1 && #1811396:1
 require_relative 'no_doc'
 require_relative 'exceptions'
 

data/lib/dom/no_doc.rb

@@ -1,5 +1,5 @@
-# ../data.img#1811401:1
 require_relative 'node'
+
 module Dom
   
   # NoDoc is used by {Dom} and {Dom::Node} to preserve the correct hierachy of

data/lib/dom/node.rb

@@ -1,4 +1,3 @@
-# ../data.img#1780307:3
 require_relative 'dom'
 require_relative 'exceptions'
 

data/lib/helper/helper.rb

@@ -1,7 +1,6 @@
-# ../data.img#1800236:1
 require 'pathname'
-require 'rdiscount'
 require 'cgi'
+require 'rdiscount'
 
 require_relative 'linker'
 

data/lib/parser/comment.rb

@@ -1,4 +1,3 @@
-# ../data.img#1781829:1
 require_relative 'meta_container'
 require_relative '../code_object/converter'
 

data/lib/parser/comment_parser.rb

@@ -1,4 +1,3 @@
-# ../data.img#1799299:1
 require_relative 'comment'
 require_relative 'exceptions'
 

data/lib/parser/meta_container.rb

@@ -1,4 +1,3 @@
-# ../data.img#1772248:1
 module Parser
 
   # is included by {CodeObject::Base} and {Parser::Comment}

data/lib/parser/parser.rb

@@ -1,4 +1,3 @@
-# ../data.img#1869414:2
 require 'strscan'
 require_relative 'comment_parser'
 

data/lib/processor.rb

@@ -4,15 +4,7 @@ require_relative 'tasks/render_task'
 require_relative 'document/document'
 
 module Processor
-  
-  RenderTask = Struct.new :name, :description, :block
-  @@render_tasks = {}
     
-  # Accessor Method for RenderTasks
-  def self.render_tasks
-    @@render_tasks
-  end
-  
   # @group Combined Stages
   
   def self.process_and_render
@@ -71,22 +63,9 @@ module Processor
   #     - files:     converts specified markdown files and renders them
   #  
   def self.perform_all_tasks
-    perform_tasks @@render_tasks.keys
+    Tasks::RenderTask.all.each { |task| task.new.perform }
   end
   
-  def self.perform_tasks(tasks)
-  
-    tasks = [tasks] unless tasks.is_a? Array
-    
-    tasks.each do |task|
-      task = task.to_sym
-      raise Exception, "No render-task registered with name '#{task}'" unless @@render_tasks.has_key? task
-      
-      Logger.debug "Rendering task '#{task}'"
-      @@render_tasks[task].new.perform
-    end
-  end 
-  
   # @group Stage #4 - Document Processor
     
   def self.prepare_documents
@@ -105,19 +84,5 @@ module Processor
       # The docs can be accessed via Dom later on
     end
   end
-  
-  
-  
-  # @group RenderTask-Setup
-  
-  def self.register_render_task(name, klass)
-    @@render_tasks[name.to_sym] = klass 
-  end
-
-  def self.unregister_render_task(name)
-    @@render_tasks.delete(name.to_sym)
-  end   
-  
-  
-  
+ 
 end

data/lib/renderer.rb

@@ -1,4 +1,3 @@
-# ../data.img#1783836:1
 require 'erb'
 require 'fileutils'
 
@@ -9,10 +8,10 @@ class Renderer
     @_layout = layout
   end
 
-  # Teilweise aus rails...
-  # @todo better error-handling with partial and layout context information!!!
+  # Pretty much inspired by Ruby on Rails
   def render(opt = nil, extra_options = {})
 
+    # Prepare Options
     if opt.nil?
       opt = { :layout => @_layout }
 
@@ -27,41 +26,9 @@ class Renderer
     end
 
     if opt[:partial]
-    
-      # add underscore to last element of foo/bar/baz
-      parts = opt[:partial].split('/')
-      parts[-1] = "_"+parts.last        
+      render_partial opt
       
-      begin
-        template_file = File.read path_to_template(parts.join('/'))
-      rescue Exception
-        raise "Could not find Partial '#{opt[:partial]}'"
-      end
-      if opt[:collection]
-
-        partial_name = opt[:partial].split('/').last
-
-        opt[:collection].map { |item|
-          define_singleton_method(partial_name) { item }
-          ERB.new(template_file).result(binding)
-        }.join "\n"
-      else
-
-        # If there are locals we have to save our instance binding, otherwise we will store our
-        # newly created local-variables in the blockcontext of each_pair
-        # values has to be defined explicitly to be overridden by the block and still available inside of eval
-        if opt[:locals]
-          value = nil
-          instance_context = binding
-          opt[:locals].each_pair do |local, value|
-            Logger.warn("Please change your partial-name or local binding, because #{local} is already set in this context.") if respond_to? local
-            define_singleton_method(local) { value }
-          end
-        end
-
-        ERB.new(template_file).result(binding)
-      end
-    else
+    else    
       # bind @current_path correctly to use in helpers and views
       if opt[:to_file]
         # Make absolute
@@ -72,7 +39,13 @@ class Renderer
       end
 
       # render 'view_name', :option1 => 1, :option2 => 2
-      view = ERB.new(File.read path_to_template opt[:template]).result(binding)
+      template = path_to_template opt[:template]
+      begin
+        view = ERB.new(File.read template).result(binding)
+      rescue Exception => e
+        raise "Error while rendering #{template}\n#{e.message}"
+      end
+
       
       # then render with layout
       if opt[:layout]
@@ -105,4 +78,55 @@ class Renderer
     File.expand_path "#{file}.html.erb", @_path
   end
 
+  def render_partial(opt)
+  
+    # add underscore to last element of foo/bar/baz
+    parts = opt[:partial].split('/')
+    parts[-1] = "_"+parts.last        
+    
+    template = path_to_template(parts.join('/'))
+    
+    begin
+      template_source = File.read(template)
+    rescue Exception
+      raise "Could not find Partial '#{template}'"
+    end 
+    
+    if opt[:collection]
+
+      partial_name = opt[:partial].split('/').last
+      
+      # Render it!
+      begin          
+        opt[:collection].map { |item|
+          define_singleton_method(partial_name) { item }
+          ERB.new(template_source).result(binding)
+        }.join "\n"
+      rescue Exception => e
+        raise "Error while rendering #{partial_name}\n#{e.message}"
+      end
+    
+    # It's not a collection  
+    else
+
+      # If there are locals we have to save our instance binding, otherwise we will store our
+      # newly created local-variables in the blockcontext of each_pair
+      # values has to be defined explicitly to be overridden by the block and still available inside of eval
+      if opt[:locals]
+        value = nil
+        instance_context = binding
+        opt[:locals].each_pair do |local, value|
+          Logger.warn("Please change your partial-name or local binding, because #{local} is already set in this context.") if respond_to? local
+          define_singleton_method(local) { value }
+        end
+      end
+      
+      begin
+        ERB.new(template_source).result(binding)
+      rescue Exception => e
+        raise "Error while rendering #{template}\n#{e.message}"
+      end
+    end
+  end
+
 end

data/lib/tasks/render_task.rb

@@ -33,9 +33,15 @@ module Tasks
     end
     
     def self.use(helper_module)
-     self.include helper_module
+     include helper_module
     end 
     
+    def self.all
+      Tasks.constants
+           .map { |c| Tasks.const_get c }
+           .select { |klass| klass.class == Class and klass.superclass == Tasks::RenderTask }
+    end
+    
     protected
     
     # @group Task-Specification methods
@@ -108,5 +114,6 @@ module Tasks
     def resolve(nodename)
       @_context.resolve nodename
     end
+    
   end
 end

data/lib/token/container.rb

@@ -1,4 +1,3 @@
-# ../data.img#1811394:1
 require_relative 'exceptions'
 
 module Token

data/lib/token/handler.rb

@@ -1,4 +1,3 @@
-# ../data.img#1799432:1 && #1858562:1
 require_relative 'token'
 
 # This module contains all required mixins and modules to register customized

data/templates/application.rb

@@ -4,11 +4,11 @@ require_relative 'types/prototype'
 # Load Default Tokens
 require_relative 'tokens/tokens'
 
-# Register Rendertasks
+# 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'
-
-# Register Helpers
-require_relative 'helpers/template'
+require_relative 'tasks/json_data_task'

data/templates/helpers/template.rb

@@ -1,76 +1,68 @@
-module Helper
+# This Helper-methods are template-specific ones. If you are using your own template, you might not 
+# need them anymore
+# They are included in the Typed-RenderTask 
+module Helper::Template
 
-  # This Helper-methods are template-specific ones. If you are using your own template, you might not 
-  # need them anymore. 
-  module Template
+  def signature(method_or_token)
   
-    def signature(method_or_token)
-    
-      if method_or_token.is_a? Token::Token
-        params = method_or_token.children.select {|t| t.token == :param }
-        returns = method_or_token.children.select {|t| t.token == :return }
-      else
-        params = method_or_token.params
-        returns = method_or_token.returns
-      end
-    
-    
-      params = params.map { |p|
-        "<span class=\"param\">#{p.name}</span>" +
-        "<span class=\"tooltip\">(<span class=\"types\">#{p.types.map{|t| link_to(t) }.join(', ')}</span>) " +
-        "#{replace_links p.content}</span>"
-      }.join(', ') unless params.nil?
-      
-      return_types = returns.first.types.map{|type| link_to(type) }.join(', ') unless returns.nil? or returns.first.nil?
-      "(#{return_types || 'Void'}) <span class='name'>#{method_or_token.name}</span>(<span class='params'>#{params}</span>)"
+    if method_or_token.is_a? Token::Token
+      params = method_or_token.children.select {|t| t.token == :param }
+      returns = method_or_token.children.select {|t| t.token == :return }
+    else
+      params = method_or_token.params
+      returns = method_or_token.returns
     end
+  
+  
+    params = params.map { |p|
+      "<span class=\"param\">#{p.name}</span>" +
+      "<span class=\"tooltip\">(<span class=\"types\">#{p.types.map{|t| link_to(t) }.join(', ')}</span>) " +
+      "#{replace_links p.content}</span>"
+    }.join(', ') unless params.nil?
     
-    def subsection(id, opts = {})
-      unless opts[:collection].nil? or opts[:collection].size == 0
-        "<h3>#{opts[:title]}</h3><ul class=\"#{id} subsection\">" +       
-        render(:partial => opts[:partial], :collection => opts[:collection]) +
-        "</ul>"
-      end
+    return_types = returns.first.types.map{|type| link_to(type) }.join(', ') unless returns.nil? or returns.first.nil?
+    "(#{return_types || 'Void'}) <span class='name'>#{method_or_token.name}</span>(<span class='params'>#{params}</span>)"
+  end
+  
+  def subsection(id, opts = {})
+    unless opts[:collection].nil? or opts[:collection].size == 0
+      "<h3>#{opts[:title]}</h3><ul class=\"#{id} subsection\">" +       
+      render(:partial => opts[:partial], :collection => opts[:collection]) +
+      "</ul>"
     end
+  end
+  
+  def hierarchy(object) 
+    
+    children = object.children.values.reject {|c| c.is_a? CodeObject::Function }
+    parents = object.parents
     
-    def hierarchy(object) 
-      
-      children = object.children.values.reject {|c| c.is_a? CodeObject::Function }
-      parents = object.parents
-      
-      parents.map {|parent| "<ul><li>#{link_to parent, parent.name}" }.join('') +
-      "<ul><li class=\"this\">#{link_to object, object.name}<ul class=\"children\">" +
-        children.map {|child| "<li>#{link_to child}</li>" }.join('') +
-      "</ul>" * (parents.size + 2)
+    parents.map {|parent| "<ul><li>#{link_to parent, parent.name}" }.join('') +
+    "<ul><li class=\"this\">#{link_to object, object.name}<ul class=\"children\">" +
+      children.map {|child| "<li>#{link_to child}</li>" }.join('') +
+    "</ul>" * (parents.size + 2)
+  end
+  
+  def api_browser(root = Dom.root)
+    if root == Dom.root
+      output = ""
+    elsif root.is_a? Dom::NoDoc
+      output = "<li class=\"nodoc\"><span>#{root.name}</span>"
+    elsif root.is_a? CodeObject::Function
+      output = "<li class=\"function\">" + link_to(root, tag(:span, root.name))
+    else # Object
+      output = "<li class=\"object\">" + link_to(root, tag(:span, root.name))
     end
     
-    def api_browser(root = Dom.root)
-      if root == Dom.root
-        output = ""
-      elsif root.is_a? Dom::NoDoc
-        output = "<li class=\"nodoc\"><span>#{root.name}</span>"
-      elsif root.is_a? CodeObject::Function
-        output = "<li class=\"function\">" + link_to(root, tag(:span, root.name))
-      else # Object
-        output = "<li class=\"object\">" + link_to(root, tag(:span, root.name))
+    if root.has_children?        
+      output += "<ul>"
+      root.children.values.each do |child|
+        output += api_browser(child)
       end
-      
-      if root.has_children?        
-        output += "<ul>"
-        root.children.values.each do |child|
-          output += api_browser(child)
-        end
-        output += "</ul>"
-      end
-      
-      return output
+      output += "</ul>"
     end
-  
+    
+    return output
   end
-  
-end
 
-# @todo automatically load from application.rb
-class Tasks::RenderTask
-  include Helper::Template
 end

data/templates/tasks/api_index_task.rb

@@ -21,6 +21,4 @@ module Tasks
       end    
     end
   end
-end
-
-Processor.register_render_task :api_index, Tasks::ApiIndexTask
+end

data/templates/tasks/docs_task.rb

@@ -1,7 +1,7 @@
 module Tasks
 
   class DocsTask < RenderTask
-
+  
     describe     'renders all specified Markdown files to static documentation'
     layout       'application'
     
@@ -28,6 +28,4 @@ module Tasks
     end
 
   end
-end
-
-Processor.register_render_task :docs, Tasks::DocsTask
+end

data/templates/tasks/json_data_task.rb

@@ -50,6 +50,4 @@ module Tasks
       end    
     end
   end
-end
-
-Processor.register_render_task :json_data, Tasks::JsonDataTask
+end

data/templates/tasks/typed_task.rb

@@ -2,7 +2,6 @@ module Tasks
 
   class TypedTask < RenderTask
 
-
     # @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
     describe     'renders documented objects type-dependant (Functions and Objects)'
@@ -49,6 +48,4 @@ module Tasks
       end
     end    
   end
-end
-
-Processor.register_render_task :typed, Tasks::TypedTask
+end

data/templates/types/prototype.rb

@@ -1,20 +1,15 @@
-module CodeObject
-
-  class Prototype < CodeObject::Object
-    
-    def initialize(*args)
-      super(*args)
-      @path += '.prototype'
-    end
-    
-    # get the constructor, for which this prototype is used
-    def constructor
-      self.parent
-    end
-    
+class CodeObject::Prototype < CodeObject::Object
+  
+  def initialize(*args)
+    super(*args)
+    @path += '.prototype'
+  end
+  
+  # get the constructor, for which this prototype is used
+  def constructor
+    self.parent
   end
-    
+  
 end
 
-CodeObject::Type.register :prototype, CodeObject::Prototype
-Token::Handler.register :prototype, :handler => :noop, :area => :none
+Token::Handler.register :prototype, :handler => :noop, :area => :none

metadata

@@ -2,7 +2,7 @@
 name: docjs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - "Jonathan Brachth\xC3\xA4user"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +02:00
+date: 2011-06-17 00:00:00 +02:00
 default_executable: bin/docjs
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,7 +58,6 @@ files:
 - 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

data/lib/code_object/type.rb

@@ -1,43 +0,0 @@
-require_relative 'exceptions'
-
-module CodeObject 
-
-  module Type
-  
-    @@types = {}
-  
-    def self.register(tokenid, klass)
-      @@types[tokenid.to_sym] = klass
-    end  
-    
-    def self.create_matching_object(tokenlines)          
-      klass = self.find_klass(tokenlines) or return nil
-      self[klass.token].new(klass.content)
-    end
-    
-    protected
-    
-    def self.[](tokenid)
-      @@types[tokenid.to_sym]
-    end
-    
-    def self.include?(tokenid)
-      @@types.has_key? tokenid.to_sym
-    end
-    
-    def self.find_klass(tokenlines)
-      klass = tokenlines.select {|t| self.include? t.token }
-      
-      if klass.size > 1
-        raise CodeObject::MultipleTypeDeclarations.new, "Wrong number of TypeDeclarations: #{klass}"
-      elsif klass.size == 0
-        # it's not possible to create instance
-        return nil
-      end
-      
-      klass.first
-    end
-    
-  end
-  
-end