imedo-css_doc 0.0.3 → 0.0.4

data/src/css_doc/document_documentation.rb

@@ -1,19 +1,5 @@
 module CSSDoc
   class DocumentDocumentation < Documentation
-    attr_accessor :file, :note, :appdef, :link, :copyright, :author, :css_for, :version
-  
-    def parse(lines)
-      section_text = []
-      lines.each do |line|
-        unless parse_one_liners(line)
-          section_text << line
-        end
-      end
-      sections << TextSection.new(section_text)
-    end
-    
-    def one_liners
-      ['file', 'note', 'appdef', 'link', 'copyright', 'author', 'css-for', 'version']
-    end
+    define_tag :file, :note, :appdef, :link, :copyright, :author, :css_for, :version
   end
 end

data/src/css_doc/documentation.rb

@@ -36,6 +36,17 @@ module CSSDoc
     attr_accessor :comment
     attr_accessor :sections
     
+    def self.tags
+      @tags ||= []
+    end
+    
+    def self.define_tag(*names)
+      names.each do |name|
+        attr_accessor name
+        tags << name
+      end
+    end
+    
     def initialize(comment)
       @comment = comment
       @sections = Sections.new
@@ -46,21 +57,17 @@ module CSSDoc
       @comment
     end
     
-    def parse_one_liners(line)
-      one_liners.each do |one_liner|
-        rx = /@#{one_liner}/
+    def parse_tags(line)
+      self.class.tags.each do |tag|
+        rx = /@#{tag.to_s.gsub('_', '-')}/
         if line =~ rx
-          instance_variable_set(:"@#{one_liner.gsub('-', '_')}", line.gsub(rx, "").strip)
+          instance_variable_set(:"@#{tag}", line.gsub(rx, "").strip)
           return true
         end
       end
       return false
     end
     
-    def one_liners
-      []
-    end
-    
     def parse_comment
       @parsed_comment ||= comment.gsub(/\*\/$/, '').split("\n").collect { |line| line.gsub(/^\s*\*/, '') }
     end
@@ -75,7 +82,26 @@ module CSSDoc
     end
   
     def parse(lines)
-      raise NotImplementedError
+      section_type = TextSection
+      section_text = []
+      lines.each do |line|
+        unless parse_tags(line)
+          if line =~ /@code/
+            sections << section_type.new(section_text)
+            section_text = []
+            section_type = CodeSection
+          elsif line =~ /@endcode/
+            sections << section_type.new(section_text)
+            section_text = []
+            section_type = TextSection
+          elsif line =~ /@description/
+            section_text << line.gsub(/@description/, '')
+          else
+            section_text << line
+          end
+        end
+      end
+      sections << section_type.new(section_text)
     end
   end
 end

data/src/css_doc/driver.rb

@@ -22,9 +22,8 @@ module CSSDoc
 
         FileUtils.mkdir_p("#{@options[:output_dir]}/#{File.dirname(relative_path)}")
         doc = CSSDoc::Document.parse(File.read(file_name), relative_path)
-
-        html = CSSDoc::DocumentTemplate.new(doc, @options).render
-        File.open("#{@options[:output_dir]}/#{doc.output_file_name}", 'w') { |file| file.puts html }
+        
+        generate(:template => 'document', :file_name => doc.output_file_name, :locals => { :document => doc, :title => doc.name })
 
         @collection.documents << doc
       end
@@ -32,24 +31,20 @@ module CSSDoc
     
     def generate_index_documentation
       log "Generating Selector Index ..."
-
-      html = CSSDoc::SelectorIndexTemplate.new(@collection, @options).render
-      File.open("#{@options[:output_dir]}/selector_index.html", 'w') { |file| file.puts html }
+      
+      generate(:template => 'selector_index', :locals => { :collection => @collection, :title => 'Selector Index' })
 
       log "Generating File Index ..."
 
-      html = CSSDoc::FileIndexTemplate.new(@collection, @options).render
-      File.open("#{@options[:output_dir]}/file_index.html", 'w') { |file| file.puts html }
+      generate(:template => 'file_index', :locals => { :collection => @collection, :title => 'File Index' })
 
       log "Generating Section Index ..."
 
-      html = CSSDoc::SectionIndexTemplate.new(@collection, @options).render
-      File.open("#{@options[:output_dir]}/section_index.html", 'w') { |file| file.puts html }
+      generate(:template => 'section_index', :locals => { :collection => @collection, :title => 'Section Index' })
 
       log "Generating Index Page ..."
 
-      html = CSSDoc::IndexTemplate.new(@options).render
-      File.open("#{@options[:output_dir]}/index.html", 'w') { |file| file.puts html }
+      generate(:template => 'index', :locals => { :project_name => @options[:project_name], :title => 'Index' })
     end
     
     def generate_css
@@ -68,5 +63,17 @@ module CSSDoc
     def log(string)
       puts string if @options[:verbose]
     end
+    
+  private
+    def generate(params)
+      file_name = params[:file_name] || params[:template]
+      file_name += '.html' unless file_name =~ /\.html$/
+      
+      relative_root = '.'
+      relative_root = (['..'] * File.dirname(file_name).split('/').size).join('/') if file_name =~ /\//
+
+      html = CSSDoc::Template.new(@options.merge(:relative_root => relative_root)).render(params[:template], params[:locals])
+      File.open("#{@options[:output_dir]}/#{file_name}", 'w') { |file| file.puts html }
+    end
   end
 end

data/src/css_doc/rule_set_documentation.rb

@@ -1,32 +1,5 @@
 module CSSDoc
   class RuleSetDocumentation < Documentation
-    attr_accessor :name, :formerly, :deprecated
-  
-    def parse(lines)
-      section_type = TextSection
-      section_text = []
-      lines.each do |line|
-        unless parse_one_liners(line)
-          if line =~ /@code/
-            sections << section_type.new(section_text)
-            section_text = []
-            section_type = CodeSection
-          elsif line =~ /@endcode/
-            sections << section_type.new(section_text)
-            section_text = []
-            section_type = TextSection
-          elsif line =~ /@description/
-            section_text << line.gsub(/@description/, '')
-          else
-            section_text << line
-          end
-        end
-      end
-      sections << section_type.new(section_text)
-    end
-    
-    def one_liners
-      ['name', 'formerly', 'deprecated']
-    end
+    define_tag :name, :formerly, :deprecated
   end
 end

data/src/css_doc/section_documentation.rb

@@ -1,19 +1,5 @@
 module CSSDoc
   class SectionDocumentation < Documentation
-    attr_accessor :section
-  
-    def parse(lines)
-      section_text = []
-      lines.each do |line|
-        unless parse_one_liners(line)
-          section_text << line
-        end
-      end
-      sections << TextSection.new(section_text)
-    end
-    
-    def one_liners
-      ['section']
-    end
+    define_tag :section
   end
 end

data/src/css_doc/template.rb

@@ -7,21 +7,24 @@ module CSSDoc
     def initialize(options = {})
       @options = options
     end
-
-    def render
-      content = ERB.new(template).result(binding)
-      ERB.new(layout).result(binding)
-    end
     
-    def title
+    class Evaluator
       
     end
+
+    def render(name, variables = {})
+      variables.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+      content = ERB.new(template(name)).result(binding)
+      ERB.new(layout).result(binding)
+    end
     
     def template_path
       @options[:template_path] || @@default_template_path
     end
     
-    def template
+    def template(template_name)
       File.read("#{template_path}/#{template_name}.html.erb")
     end
     
@@ -30,7 +33,7 @@ module CSSDoc
     end
     
     def relative_root
-      "."
+      @options[:relative_root] || "."
     end
     
     def truncate(string, length)

data/src/css_doc.rb

@@ -6,11 +6,6 @@ require File.dirname(__FILE__) + '/css_doc/document_collection'
 require File.dirname(__FILE__) + '/css_doc/section'
 require File.dirname(__FILE__) + '/css_doc/rule_set'
 require File.dirname(__FILE__) + '/css_doc/template'
-require File.dirname(__FILE__) + '/css_doc/document_template'
-require File.dirname(__FILE__) + '/css_doc/selector_index_template'
-require File.dirname(__FILE__) + '/css_doc/file_index_template'
-require File.dirname(__FILE__) + '/css_doc/section_index_template'
-require File.dirname(__FILE__) + '/css_doc/index_template'
 require File.dirname(__FILE__) + '/css_doc/documentation'
 require File.dirname(__FILE__) + '/css_doc/document_documentation'
 require File.dirname(__FILE__) + '/css_doc/rule_set_documentation'

data/src/rake/css_doc_task.rb

@@ -5,6 +5,7 @@ module Rake
     attr_accessor :skip_files
     attr_accessor :project_name
     attr_accessor :verbose
+    attr_accessor :template_path
     
     def initialize(name = :css_doc)
       @name = name
@@ -21,7 +22,7 @@ module Rake
         require 'css_doc'
 
         driver = CSSDoc::Driver.new
-        driver.run(:project_name => self.project_name, :input_dir => self.input_dir, :output_dir => self.output_dir, :skip_files => self.skip_files, :verbose => self.verbose)
+        driver.run(:project_name => self.project_name, :input_dir => self.input_dir, :output_dir => self.output_dir, :skip_files => self.skip_files, :verbose => self.verbose, :template_path => self.template_path)
       end
     end
   end

data/src/templates/default/layout.html.erb

@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> 
-    <title><%= title %> - CSS Documentation</title>
+    <title><%= @title %> - CSS Documentation</title>
     <link rel="stylesheet" media="all" href="<%= relative_root %>/css_doc.css" />
     <link rel="stylesheet" media="all" href="<%= relative_root %>/styles.css" />
   </head>

data/src/templates/simple/layout.html.erb

@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> 
-    <title><%= title %> - CSS Documentation</title>
+    <title><%= @title %> - CSS Documentation</title>
     <link rel="stylesheet" media="all" href="<%= relative_root %>/css_doc.css" />
     <link rel="stylesheet" media="all" href="<%= relative_root %>/styles.css" />
   </head>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: imedo-css_doc
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Thomas Kadauke
@@ -27,17 +27,12 @@ files:
 - src/css_doc/document_collection.rb
 - src/css_doc/document_documentation.rb
 - src/css_doc/document_handler.rb
-- src/css_doc/document_template.rb
 - src/css_doc/documentation.rb
 - src/css_doc/driver.rb
-- src/css_doc/file_index_template.rb
-- src/css_doc/index_template.rb
 - src/css_doc/rule_set.rb
 - src/css_doc/rule_set_documentation.rb
 - src/css_doc/section.rb
 - src/css_doc/section_documentation.rb
-- src/css_doc/section_index_template.rb
-- src/css_doc/selector_index_template.rb
 - src/css_doc/template.rb
 - src/css_doc.rb
 - src/css_pool/visitors/to_css.rb

data/src/css_doc/document_template.rb

@@ -1,24 +0,0 @@
-module CSSDoc
-  class DocumentTemplate < Template
-    def initialize(document, options = {})
-      super(options)
-      @document = document
-    end
-
-    def template_name
-      'document'
-    end
-    
-    def title
-      @document.name
-    end
-    
-    def relative_root
-      if @document.name =~ /\//
-        (['..'] * File.dirname(@document.name).split('/').size).join('/')
-      else
-        '.'
-      end
-    end
-  end
-end

data/src/css_doc/file_index_template.rb

@@ -1,16 +0,0 @@
-module CSSDoc
-  class FileIndexTemplate < Template
-    def initialize(collection, options = {})
-      super(options)
-      @collection = collection
-    end
-
-    def template_name
-      'file_index'
-    end
-    
-    def title
-      "File Index"
-    end
-  end
-end

data/src/css_doc/index_template.rb

@@ -1,16 +0,0 @@
-module CSSDoc
-  class IndexTemplate < Template
-    def initialize(options)
-      super
-      @project_name = options[:project_name]
-    end
-    
-    def template_name
-      'index'
-    end
-    
-    def title
-      "Index"
-    end
-  end
-end

data/src/css_doc/section_index_template.rb

@@ -1,16 +0,0 @@
-module CSSDoc
-  class SectionIndexTemplate < Template
-    def initialize(collection, options = {})
-      super(options)
-      @collection = collection
-    end
-
-    def template_name
-      'section_index'
-    end
-    
-    def title
-      "Section Index"
-    end
-  end
-end

data/src/css_doc/selector_index_template.rb

@@ -1,16 +0,0 @@
-module CSSDoc
-  class SelectorIndexTemplate < Template
-    def initialize(collection, options = {})
-      super(options)
-      @collection = collection
-    end
-
-    def template_name
-      'selector_index'
-    end
-    
-    def title
-      "Selector Index"
-    end
-  end
-end