allison 2.0.2 → 2.0.3

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v2.0.3. Remove wrong copyright notices (technomancy).
+
 v2.0.2. Let's not talk about that.
 
 v2.0.1. Remove PROJECT constant which isn't even used, gosh (Adam).

data/Manifest

@@ -10,11 +10,12 @@ cache/INDEX
 cache/JAVASCRIPT
 cache/METHOD_INDEX
 cache/METHOD_LIST
-cache/PROJECT
 cache/SRC_PAGE
 cache/STYLE
 CHANGELOG
 contrib/Rakefile
+contrib/rdoc_patch.rb
+contrib/rdoc_patch_test.rb
 lib/allison.css
 lib/allison.js
 lib/allison.rb

data/README

@@ -1,13 +1,14 @@
-
 Allison
 
 A modern, pretty RDoc template.
 
 == License
 
-Copyright 2007 Cloudburst, LLC. See included LICENSE file.
+Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. 
+
+The public certificate for this gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem]. 
 
-The public certificate for this gem is at http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem.
+If you like this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails.
 
 == Installation
 
@@ -55,7 +56,7 @@ If you want to generate documentation for Ruby on Rails, there is a handy trick.
 
 == Reporting problems
 
-* http://rubyforge.org/forum/forum.php?forum_id=16451
+The support forum is here[http://rubyforge.org/forum/forum.php?forum_id=16451].
 
 Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC.
 

data/allison.gemspec

@@ -1,26 +1,26 @@
 
-# Gem::Specification for Allison-2.0.2
+# Gem::Specification for Allison-2.0.3
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{allison}
-  s.version = "2.0.2"
+  s.version = "2.0.3"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
-  s.date = %q{2007-11-15}
+  s.date = %q{2008-01-21}
   s.default_executable = %q{allison}
   s.description = %q{A modern, pretty RDoc template.}
   s.email = %q{}
   s.executables = ["allison"]
-  s.files = ["bin/allison", "cache/BODY", "cache/CLASS_INDEX", "cache/CLASS_PAGE", "cache/FILE_INDEX", "cache/FILE_PAGE", "cache/FONTS", "cache/FR_INDEX_BODY", "cache/INDEX", "cache/JAVASCRIPT", "cache/METHOD_INDEX", "cache/METHOD_LIST", "cache/PROJECT", "cache/SRC_PAGE", "cache/STYLE", "CHANGELOG", "contrib/Rakefile", "lib/allison.css", "lib/allison.js", "lib/allison.rb", "LICENSE", "Manifest", "README", "allison.gemspec"]
+  s.files = ["bin/allison", "cache/BODY", "cache/CLASS_INDEX", "cache/CLASS_PAGE", "cache/FILE_INDEX", "cache/FILE_PAGE", "cache/FONTS", "cache/FR_INDEX_BODY", "cache/INDEX", "cache/JAVASCRIPT", "cache/METHOD_INDEX", "cache/METHOD_LIST", "cache/SRC_PAGE", "cache/STYLE", "CHANGELOG", "contrib/Rakefile", "contrib/rdoc_patch.rb", "contrib/rdoc_patch_test.rb", "lib/allison.css", "lib/allison.js", "lib/allison.rb", "LICENSE", "Manifest", "README", "allison.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://blog.evanweaver.com/pages/code#allison}
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{0.9.4.6}
+  s.rubygems_version = %q{1.0.1}
   s.summary = %q{A modern, pretty RDoc template.}
 end
 
@@ -37,9 +37,12 @@ end
 #   p.summary = 'A modern, pretty RDoc template.'
 #   p.url = 'http://blog.evanweaver.com/pages/code#allison'
 #   p.docs_host = 'blog.evanweaver.com:~/www/bax/public/files/doc/'
-#   p.rdoc_pattern = /\.rb|^README|^CHANGELOG|^TODO|^LICENSE$/
+#   p.rdoc_pattern = /allison.rb|^README|^CHANGELOG|^TODO|^LICENSE$/
 #   p.clean_pattern = /^doc|^pkg/
-#   p.rdoc_template = File.expand_path(File.dirname(__FILE__) + "/lib/allison")
+#   if ARGV.include? "release"
+#     STDERR.puts "Using non-gem template"
+#     p.rdoc_template = File.expand_path(File.dirname(__FILE__) + "/lib/allison")
+#   end
 # end
 # 
 # task :"cache/BODY" => [:clean, :doc] # Rebuild the cache before packaging

data/cache/BODY

@@ -1,7 +1,6 @@
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" href="%style_url%" rel="stylesheet" media="screen"/><script type="text/javascript">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" href="%style_url%" media="screen" rel="stylesheet"/><script type="text/javascript">
 // Allison template
-// Copyright 2007 Cloudburst LLC, all rights reserved
-// Redistribution or modification prohibited
+// Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file.
 
 var href_base = '%style_url%'.replace(/(.*\/).*/, '$1'); // inline js is good for something  
 
@@ -568,4 +567,4 @@ ENDIF:method_list
 END:sections
 
 ENDIF:sections
-</div><div class="clear" id="footer">Generated on Nov 15, 2007 / Allison 2 &copy; 2007 <a href="http://cloudbur.st">Cloudburst, LLC</a></div></div></body></html>
+</div><div class="clear" id="footer">Generated on Jan 21, 2008 / Allison 2 &copy; 2007 <a href="http://cloudbur.st">Cloudburst, LLC</a></div></div></body></html>

data/cache/INDEX

@@ -1 +1 @@
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" href="rdoc-style.css" rel="stylesheet" media="screen"/><meta content="0;url=%initial_page%" http-equiv="refresh"/></head><body><div id="container"><div class="curve" id="preheader_curve_0"></div><div class="curve" id="preheader_curve_1"></div><div class="curve" id="preheader_curve_2"></div><div class="curve" id="preheader_curve_3"></div><div class="curve" id="preheader_curve_4"></div><div class="curve" id="preheader_curve_5"></div><div id="header"><span id="title"><p>&nbsp;</p><h1>Ruby Documentation</h1></span></div><div class="clear"></div><div id="redirect"><a href="%initial_page%"><h1>Redirect</h1></a></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" href="rdoc-style.css" media="screen" rel="stylesheet"/><meta content="0;url=%initial_page%" http-equiv="refresh"/></head><body><div id="container"><div class="curve" id="preheader_curve_0"></div><div class="curve" id="preheader_curve_1"></div><div class="curve" id="preheader_curve_2"></div><div class="curve" id="preheader_curve_3"></div><div class="curve" id="preheader_curve_4"></div><div class="curve" id="preheader_curve_5"></div><div id="header"><span id="title"><p>&nbsp;</p><h1>Ruby Documentation</h1></span></div><div class="clear"></div><div id="redirect"><a href="%initial_page%"><h1>Redirect</h1></a></div></div></body></html>

data/cache/JAVASCRIPT

@@ -1,7 +1,6 @@
 
 // Allison template
-// Copyright 2007 Cloudburst LLC, all rights reserved
-// Redistribution or modification prohibited
+// Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file.
 
 var href_base = '%style_url%'.replace(/(.*\/).*/, '$1'); // inline js is good for something  
 

data/cache/STYLE

@@ -1,8 +1,7 @@
 
 /*;
-Allison template;
-Copyright 2007 Cloudburst LLC, all rights reserved;
-Redistribution or modification prohibited;
+Allison 2 template;
+Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file.;
 */;
 
 /* default styles */

data/contrib/rdoc_patch.rb

@@ -0,0 +1,252 @@
+#  CONSIDER  split the patch in two for separate submissions
+
+##################################################################
+##  eek eek ook ook patch to add directives to RDocage
+
+require 'rdoc/rdoc'
+require 'rdoc/markup/simple_markup'
+require 'rdoc/markup/simple_markup/lines'
+require 'rdoc/markup/simple_markup/fragments'
+require 'rdoc/markup/simple_markup/to_html'
+
+
+def find_method_contents(file_info, modool, method)
+  file_info.each do |top|
+    if mod   = top.find_module_named(modool) and
+      symbol = mod.find_local_symbol(method)
+        return symbol.token_stream
+    end
+  end
+  return nil
+end
+
+module RubyToken
+  class Token
+    def to_html
+      html = CGI.escapeHTML(text)
+      
+      if text.size == 1 and '!@#$%^&*(){}?+/=[]\\|.,"\'<>-_;:'.include?(text)
+        return "<strong>#{ html }</strong>"
+      else
+        return html
+      end
+    end
+  end
+
+  class TkCOMMENT;     def to_html; '<em style="color: #666; font-size: 110%">' + super + '</em>'    ; end; end
+  class TkKW;          def to_html; '<span style="color: #990099">' + super + '</span>'  ; end; end
+  class TkIDENTIFIER;  def to_html; '<span style="color: #003399">' + super + '</span>'  ; end; end
+  class TkSYMBOL ;     def to_html; '<span style="color: #006600">' + super + '</span>'  ; end; end
+  class TkOp;          def to_html; '<strong>' + super + '</strong>'  ; end; end
+  class TkSTRING;      def to_html; '<span style="background-color: #ddffdd">' + super + '</span>'  ; end; end
+
+#<RubyToken::TkASSIGN:0xb7870368 @text="=", @char_no=11, @line_no=346>
+#<RubyToken::TkTRUE:0xb786ddac @text="true", @char_no=19, @line_no=347, @name="true">
+#<RubyToken::TkCOMMA:0xb786db7c @text=",", @char_no=23, @line_no=347>
+#<RubyToken::TkfLBRACK:0xb786d2d0 @text="[", @char_no=30, @line_no=347>
+#<RubyToken::TkRBRACK:0xb786c8d0 @text="]", @char_no=39, @line_no=347>
+#<RubyToken::TkFALSE:0xb7868488 @text="false", @char_no=19, @line_no=349, @name="false">
+  
+end
+
+module SM
+
+  class Line
+    PURE_HTML = :PURE_HTML
+    PURE_RUBY = :PURE_RUBY
+    TRANSCLUDE = :TRANSCLUDE
+  end
+
+  class PureHTML < Fragment
+    type_name Line::PURE_HTML
+  end
+
+  class PureRUBY < Fragment
+    type_name Line::PURE_RUBY
+  end
+
+  class Transclude < Fragment
+    type_name Line::TRANSCLUDE
+  end
+
+  class ToHtml
+    def accept_transclude(am, fragment)
+      if found = find_method_contents(@context.context.parent.in_files, *fragment.txt.split('#'))
+        @res << '<pre style="background-color: white">'
+        #  to do: hilite syntax; make method name clickable
+        found.each_with_index do |tok, index|
+          next if 0 == index and tok.text =~ /^\#/
+          next if 1 == index and tok.text == "\n"
+          @res << tok.to_html
+        end
+        @res << '</pre>'
+      else
+        raise "missing transclusion: #{ fragment.inspect }"
+        @res << fragment.txt
+      end
+    end
+    
+    def accept_pure_html(am, fragment)
+      @res << fragment.txt
+    end
+    
+    def accept_pure_ruby(am, fragment)
+      @res << eval(fragment.txt)
+    end
+  end
+
+  class LineCollection  
+    def accept(am, visitor)
+      visitor.start_accepting
+
+      @fragments.each do |fragment|
+        case fragment
+        when Verbatim
+          visitor.accept_verbatim(am, fragment)
+        when PureHTML
+           visitor.accept_pure_html(am, fragment)
+        when PureRUBY
+           visitor.accept_pure_ruby(am, fragment)
+        when Transclude
+           visitor.accept_transclude(am, fragment)
+        when Rule
+          visitor.accept_rule(am, fragment)
+        when ListStart
+          visitor.accept_list_start(am, fragment)
+        when ListEnd
+          visitor.accept_list_end(am, fragment)
+        when ListItem
+          visitor.accept_list_item(am, fragment)
+        when BlankLine
+          visitor.accept_blank_line(am, fragment)
+        when Heading
+          visitor.accept_heading(am, fragment)
+        when Paragraph
+          visitor.accept_paragraph(am, fragment)
+        end
+      end
+
+      visitor.end_accepting
+    end
+  
+  end
+  
+  class SimpleMarkup
+  private
+  
+    def assign_types_to_lines(margin = 0, level = 0)
+
+      while line = @lines.next
+      
+        if /^\s*%html/ === line.text then
+          line.text.sub!("%html","")
+          line.stamp( Line::PURE_HTML, level )
+          next
+        end
+      
+        if /^\s*%transclude/ === line.text then
+          line.text.sub!("%transclude","")
+          line.stamp( Line::TRANSCLUDE, level )
+          next
+        end
+      
+        if /^\s*%ruby/ === line.text then
+          line.text.sub!("%ruby","")
+          line.stamp( Line::PURE_RUBY, level )
+          next
+        end
+      
+        if line.isBlank?
+          line.stamp(Line::BLANK, level)
+          next
+        end
+        
+        # if a line contains non-blanks before the margin, then it must belong
+        # to an outer level
+
+        text = line.text
+        
+        for i in 0...margin
+          if text[i] != SPACE
+            @lines.unget
+            return
+          end
+        end
+
+        active_line = text[margin..-1]
+
+        # Rules (horizontal lines) look like
+        #
+        #  ---   (three or more hyphens)
+        #
+        # The more hyphens, the thicker the rule
+        #
+
+        if /^(---+)\s*$/ =~ active_line
+          line.stamp(Line::RULE, level, $1.length-2)
+          next
+        end
+
+        # Then look for list entries. First the ones that have to have
+        # text following them (* xxx, - xxx, and dd. xxx)
+
+        if SIMPLE_LIST_RE =~ active_line
+
+          offset = margin + $1.length
+          prefix = $2
+          prefix_length = prefix.length
+
+          flag = case prefix
+                 when "*","-" then ListBase::BULLET
+                 when /^\d/   then ListBase::NUMBER
+                 when /^[A-Z]/ then ListBase::UPPERALPHA
+                 when /^[a-z]/ then ListBase::LOWERALPHA
+                 else raise "Invalid List Type: #{self.inspect}"
+                 end
+
+          line.stamp(Line::LIST, level+1, prefix, flag)
+          text[margin, prefix_length] = " " * prefix_length
+          assign_types_to_lines(offset, level + 1)
+          next
+        end
+
+
+        if LABEL_LIST_RE =~ active_line
+          offset = margin + $1.length
+          prefix = $2
+          prefix_length = prefix.length
+
+          next if handled_labeled_list(line, level, margin, offset, prefix)
+        end
+
+        # Headings look like
+        # = Main heading
+        # == Second level
+        # === Third
+        #
+        # Headings reset the level to 0
+
+        if active_line[0] == ?= and active_line =~ /^(=+)\s*(.*)/
+          prefix_length = $1.length
+          prefix_length = 6 if prefix_length > 6
+          line.stamp(Line::HEADING, 0, prefix_length)
+          line.strip_leading(margin + prefix_length)
+          next
+        end
+        
+        # If the character's a space, then we have verbatim text,
+        # otherwise 
+
+        if active_line[0] == SPACE
+          line.strip_leading(margin) if margin > 0
+          line.stamp(Line::VERBATIM, level)
+        else
+          line.stamp(Line::PARAGRAPH, level)
+        end
+      end
+    end
+  end
+end
+
+##  eek eek ook ook patch to add directives to RDocage
+##################################################################

data/contrib/rdoc_patch_test.rb

@@ -0,0 +1,95 @@
+#:stopdoc:
+require 'rdoc/rdoc'
+require 'test/unit'
+require 'fileutils'
+#:startdoc:
+
+MY_ROOT = File.dirname(__FILE__)
+require MY_ROOT + '/../doc/rdoc_patch'
+require MY_ROOT + '/../lib/assert_xpath'  #  assert_xpath vs RDoc!!!
+
+
+def doc(thing)
+    puts (thing.public_methods - self.public_methods).sort()
+end
+
+
+class String
+  def blank?
+    return strip.size == 0
+  end
+end
+
+#:stopdoc:
+  #  ERGO  shouldn't %HTML be :html: ?
+#:startdoc:
+
+class RDocMonkeyPatchTest < Test::Unit::TestCase
+  include AssertXPath
+
+  def publish(file_1_contents, file_2_contents)
+    rdoc = RDoc::RDoc.new
+    args = ['scratch_1.rb', 'scratch_2.rb', '-oscratch', '--quiet']
+    File.open(args[0], 'w'){|f|  f.write file_1_contents  }
+    File.open(args[1], 'w'){|f|  f.write file_2_contents  }
+    rdoc.document(args)
+  end
+ 
+  def test_rdoc_raw_ruby
+    publish("
+             class Foo
+               # %ruby 'in the zone'
+               def daddys_got_them_debellum_blues
+               end
+             end", '')
+          
+    assert_xml File.read('scratch/classes/Foo.html')
+    assert_tag_id :div, 'method-M000003' do  #  CONSIDER: why 003 ?
+      assert_xpath 'div[ "method-description" = @class ]' do |div|
+        assert_match 'in the zone', div.inner_text
+      end
+    end
+  end
+  
+  def test_rdoc_crosspatch
+    publish("
+             class Foo
+               # exemplary
+               def i_think_were_alone_now
+                 # payload
+               end
+              end
+             ", "
+             class Bar
+               # See Foo#i_think_were_alone_now
+               # %transclude Foo#i_think_were_alone_now
+               def sugar_minot
+               end
+             end
+             ")
+
+    assert_xml File.read('scratch/classes/Foo.html')
+
+    assert_tag_id :div, 'method-M000001' do
+      assert_xpath 'div[ "method-description" = @class ]' do |div|
+        assert_match 'exemplary', div.inner_text
+      end
+    end
+    
+    assert_xml File.read('scratch/classes/Bar.html')
+    
+    assert_tag_id :div, 'method-M000002' do
+      assert_xpath 'div[ "method-description" = @class ]' do |div|
+        assert_match 'i_think_were_alone_now', div.inner_text
+        assert_match 'payload', div.inner_text
+      end
+    end
+  end
+  
+  def teardown
+    FileUtils.rm_rf('scratch')   rescue nil
+    File.unlink('scratch_1.rb')  rescue nil
+    File.unlink('scratch_2.rb')  rescue nil
+  end
+end
+

data/lib/allison.css

@@ -1,8 +1,7 @@
 
 /* 
- Allison template
- Copyright 2007 Cloudburst LLC, all rights reserved
- Redistribution or modification prohibited
+ Allison 2 template
+ Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file.
 */
 
 /* default styles */

data/lib/allison.js

@@ -1,7 +1,6 @@
 
 // Allison template
-// Copyright 2007 Cloudburst LLC, all rights reserved
-// Redistribution or modification prohibited
+// Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file.
 
 var href_base = '%style_url%'.replace(/(.*\/).*/, '$1'); // inline js is good for something  
 

metadata

@@ -1,35 +1,12 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4.6
-specification_version: 2
 name: allison
 version: !ruby/object:Gem::Version 
-  version: 2.0.2
-date: 2007-11-15 00:00:00 -05:00
-summary: A modern, pretty RDoc template.
-require_paths: 
-- lib
-email: ""
-homepage: http://blog.evanweaver.com/pages/code#allison
-rubyforge_project: fauna
-description: A modern, pretty RDoc template.
+  version: 2.0.3
+platform: ruby
+authors: 
+- Evan Weaver
 autorequire: 
-default_executable: 
 bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-platform: ruby
-signing_key: 
 cert_chain: 
 - |
   -----BEGIN CERTIFICATE-----
@@ -53,9 +30,18 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-post_install_message: 
-authors: 
-- Evan Weaver
+date: 2008-01-21 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A modern, pretty RDoc template.
+email: ""
+executables: 
+- allison
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - bin/allison
 - cache/BODY
@@ -69,11 +55,12 @@ files:
 - cache/JAVASCRIPT
 - cache/METHOD_INDEX
 - cache/METHOD_LIST
-- cache/PROJECT
 - cache/SRC_PAGE
 - cache/STYLE
 - CHANGELOG
 - contrib/Rakefile
+- contrib/rdoc_patch.rb
+- contrib/rdoc_patch_test.rb
 - lib/allison.css
 - lib/allison.js
 - lib/allison.rb
@@ -81,17 +68,31 @@ files:
 - Manifest
 - README
 - allison.gemspec
-test_files: []
-
+has_rdoc: true
+homepage: http://blog.evanweaver.com/pages/code#allison
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: 
-- allison
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: fauna
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A modern, pretty RDoc template.
+test_files: []
 

data/cache/PROJECT

@@ -1 +0,0 @@
-allison