css_doc 0.0.6

data/src/css_doc/section_documentation.rb

@@ -0,0 +1,5 @@
+module CSSDoc
+  class SectionDocumentation < Documentation
+    define_tag :section
+  end
+end

data/src/css_doc/template.rb

@@ -0,0 +1,47 @@
+require 'erb'
+
+module CSSDoc
+  class Template
+    @@default_template_path = File.dirname(__FILE__) + '/../templates/default'
+    
+    def initialize(options = {})
+      @options = options
+    end
+    
+    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(template_name)
+      File.read("#{template_path}/#{template_name}.html.erb")
+    end
+    
+    def layout
+      File.read("#{template_path}/layout.html.erb")
+    end
+    
+    def relative_root
+      @options[:relative_root] || "."
+    end
+    
+    def truncate(string, length)
+      if string.size > length
+        string[0..(length - 4)] + '...'
+      else
+        string
+      end
+    end
+  end
+end

data/src/css_pool/visitors/to_css.rb

@@ -0,0 +1,9 @@
+module CSSPool
+  module Visitors
+    class ToCSS
+      def visit_CSSDoc_RuleSet(*args)
+        visit_CSSPool_CSS_RuleSet(*args)
+      end
+    end
+  end
+end

data/src/rake/css_doc_task.rb

@@ -0,0 +1,29 @@
+module Rake
+  class CSSDocTask < TaskLib
+    attr_accessor :input_dir
+    attr_accessor :output_dir
+    attr_accessor :skip_files
+    attr_accessor :project_name
+    attr_accessor :verbose
+    attr_accessor :template_path
+    
+    def initialize(name = :css_doc)
+      @name = name
+      @input_dir = 'public/stylesheets'
+      @output_dir = 'css_doc'
+      @template_path = File.expand_path(File.dirname(__FILE__) + '/../templates/default')
+
+      yield self if block_given?
+      define
+    end
+    
+    def define
+      task @name do
+        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, :template_path => self.template_path)
+      end
+    end
+  end
+end

data/src/templates/default/css_doc.css

@@ -0,0 +1,286 @@
+/**
+* @file css_doc.css
+* @author Thomas Kadauke
+* @css-for Safari 4, Firefox 3
+*/
+
+/**
+* @section Reset styles
+* These styles reset the default style sheet that comes with the user agent.
+*/
+
+/**
+* Set margins and paddings to 0, and font-properties to a default value.
+*/
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  outline: 0;
+  font-weight: inherit;
+  font-style: inherit;
+  font-size: 100%;
+  font-family: inherit;
+  vertical-align: baseline;
+}
+/**
+* Reset focus styles to nothing.
+* Remember to define focus styles in after this declaration.
+*/
+:focus {
+  outline: 0;
+}
+/**
+* Reset text color and line height.
+*/
+body {
+  line-height: 1;
+  color: black;
+  background: white;
+}
+/**
+* Remove default list decoration.
+*/
+ol, ul {
+  list-style: none;
+}
+/*
+* Remove default table styling.
+* Tables still need 'cellspacing="0"' in the markup.
+*/
+table {
+  border-collapse: separate;
+  border-spacing: 0;
+}
+/**
+* Reset text alignment and typography for special tags.
+*/
+caption, th, td {
+  text-align: left;
+  font-weight: normal;
+}
+/**
+* Remove CSS generated content around citation tags.
+*/
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: "";
+}
+blockquote, q {
+  quotes: "" "";
+}
+
+/**
+* @section Typography
+*/
+
+/**
+* A font size of 100.01% on the html tag makes it possible to easily convert
+* em's to pixels with default font size settings in all major browsers.
+*/
+html {
+  font-size: 100.01%;
+}
+
+/**
+* Reset font size so that 1 em is 10 pixels.
+*/
+body {
+  font-size: 62.5%;
+  font-family: Arial, Verdana, Tahoma, 'Bitstream Vera Sans', sans serif;
+}
+
+/**
+* Set font size and spacing.
+*/
+#canvas {
+  font-size: 1.2em;
+  line-height: 1.3;
+}
+
+p {
+  margin-bottom: 0.5em;
+}
+
+/**
+* Use typewriter font for code examples.
+*/
+pre {
+  font-family: Courier;
+  width: 100%;
+  overflow: auto;
+}
+
+/**
+* @section Headers
+*/
+
+/**
+* All headers use the same font, same margins, but different font sizes.
+*/
+h1, h2, h3, h4, h5, h6                      { font-family: 'Arial', sans serif; font-weight: normal; line-height: 1; margin: 0 0 .5em 0; padding: 0; }
+h1                                          { font-size: 1.9em; }
+h2                                          { font-size: 1.8333333em; }
+h3                                          { font-size: 1.6em; }
+h4                                          { font-size: 1.4em; }
+h5                                          { font-size: 1em; }
+h6                                          { font-size: 1em; }
+
+/**
+* @section Layout
+*/
+
+body {
+  padding: 1em;
+}
+
+.content {
+  margin-left: 15em;
+}
+
+/**
+* Push navigation to the left-hand side.
+*/
+.navigation {
+  float: left;
+  width: 9em;
+}
+
+/**
+* @section Lists
+*/
+
+dl {
+  margin-bottom: 0.5em;
+}
+
+dt {
+  font-weight: bold;
+}
+
+/**
+* Use nice indentation to make definition items more distinguishable from the
+* terms.
+*/
+dd {
+  padding-left: 2em;
+}
+
+/**
+* @section Indexes
+*/
+
+/**
+* Index list items should be next to each other.
+*/
+dl.index ul li {
+  display: inline;
+}
+
+/**
+* Separate index list items by commas via CSS.
+*/
+dl.index ul li:after {
+  content: ', ';
+}
+
+/**
+* No comma for the last index list item.
+*/
+dl.index ul li:last-child:after {
+  content: '';
+}
+
+/**
+* Actually use bullets for the file index.
+*/
+ul.file-index {
+  list-style-type: disc;
+}
+
+ul.file-index li {
+  margin-left: 3em;
+}
+
+/**
+* @section Document page
+*/
+
+ul.rule-sets, ul.sections {
+  margin-bottom: 0.5em;
+}
+
+/**
+* Like index lists, the table of contents lists on the document page should be
+* inlined.
+*/
+ul.sections li, ul.rule-sets li {
+  display: inline;
+}
+
+/**
+* Again, use CSS-generated commas to separate the items.
+*/
+ul.sections li:after, ul.rule-sets li:after {
+  content: ', ';
+}
+
+/**
+* No comma for the last one.
+*/
+ul.sections li:last-child:after, ul.rule-sets li:last-child:after {
+  content: '';
+}
+
+/**
+* Give section headers a visual emphasis.
+*/
+h3.section {
+  border-top: 1px solid #000;
+  border-bottom: 1px solid #000;
+  margin-top: 1em;
+  margin-bottom: 1em;
+}
+
+/**
+* Examples are surrounded by a thick border. Also there is a rather large
+* padding to make it clear where the example starts. This selector is the
+* namespace for generated CSS, which is used to style the example in the box.
+*/
+div.example {
+  margin: 1em 0 1em 2em;
+  border: 2px solid #000;
+  padding: 1em;
+}
+
+/**
+* @section Table of contents
+*/
+
+ul.navigation li {
+  border-top: 1px solid #000;
+  padding: 0.25em;
+}
+
+ul.navigation li:last-child {
+  border-bottom: 1px solid #000;
+}
+
+/**
+* @section Footer
+*/
+
+/**
+* Center footer line.
+*/
+#footer {
+  margin-top: 2em;
+  text-align: center;
+}

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

@@ -0,0 +1,93 @@
+<h1>Document <%= @document.name %></h1>
+<% if @document.documentation %>
+  <dl>
+    <% if @document.documentation.author %>
+      <dt>Author</dt>
+      <dd><%= @document.documentation.author %></dd>
+    <% end %>
+    <% if @document.documentation.appdef %>
+      <dt>Application</dt>
+      <dd><%= @document.documentation.appdef %></dd>
+    <% end %>
+    <% if @document.documentation.link %>
+      <dt>URL</dt>
+      <dd><%= @document.documentation.link %></dd>
+    <% end %>
+    <% if @document.documentation.copyright %>
+      <dt>Copyright</dt>
+      <dd><%= @document.documentation.copyright %></dd>
+    <% end %>
+    <% if @document.documentation.css_for %>
+      <dt>Compatible browsers</dt>
+      <dd><%= @document.documentation.css_for %></dd>
+    <% end %>
+    <% if @document.documentation.author %>
+      <dt>Version</dt>
+      <dd><%= @document.documentation.author %></dd>
+    <% end %>
+    <% if @document.documentation.date %>
+      <dt>Date</dt>
+      <dd><%= @document.documentation.date %></dd>
+    <% end %>
+    <% if @document.documentation.license %>
+      <dt>License</dt>
+      <dd><%= @document.documentation.license %></dd>
+    <% end %>
+  </dl>
+  
+  <%= @document.documentation.sections.to_html %>
+<% end %>
+
+<h2>Contents</h2>
+
+<% unless @document.named_sections.empty? %>
+  <h3>Sections</h3>
+
+  <ul class="sections">
+    <% @document.named_sections.sort_by {|section| section.name}.each do |section| %>
+      <li><a href="#section-<%= section.object_id %>"><%= section.name %></a></li>
+    <% end %>
+  </ul>
+<% end %>
+
+<h3>Rule sets</h3>
+
+<ul class="rule-sets">
+  <% @document.rule_sets.sort_by {|set| set.selector_css}.each do |rule_set| %>
+    <li><a href="#rule-set-<%= rule_set.object_id %>" title="<%= rule_set.selector_css %>"><%= truncate(rule_set.selector_css, 40) %></a></li>
+  <% end %>
+</ul>
+
+<h2>Documentation</h2>
+
+<% @document.sections.each do |section| %>
+  <% if section.name %>
+    <h3 class="section" id="section-<%= section.object_id %>"><%= section.name %></h3>
+  <% end %>
+  
+  <%= section.documentation.sections.to_html %>
+  
+  <% section.rule_sets.each do |rule_set| %>
+    <h4 class="rule-set" id="rule-set-<%= rule_set.object_id %>">Rule set <%= rule_set.documentation.name || "(unnamed)" %></h4>
+
+    <dl>
+      <dt>Selectors</dt>
+      <dd><%= rule_set.selector_css %></dd>
+
+      <dt>Properties</dt>
+      <dd><%= rule_set.declaration_css %></dd>
+
+      <% if rule_set.documentation.formerly %>
+        <dt>Formerly</dt>
+        <dd><%= rule_set.documentation.formerly %></dd>
+      <% end %>
+      
+      <% if rule_set.documentation.deprecated %>
+        <dt>Deprecated</dt>
+        <dd><%= rule_set.documentation.deprecated %></dd>
+      <% end %>
+    </dl>
+
+    <%= rule_set.documentation.sections.to_html %>
+  <% end %>
+<% end %>