rlzxdoc 0.0.1 → 0.0.2

data/History.txt

@@ -2,3 +2,8 @@
 
 * 1 major enhancement:
   * Initial release
+
+==0.0.2 2008-03-23
+
+* 1 tiny enhancement:
+  * Sorted navigation by path / title

data/Manifest.txt

@@ -9,6 +9,7 @@ config/requirements.rb
 lib/rlzxdoc.rb
 lib/rlzxdoc/lzxclass.rb
 lib/rlzxdoc/lzxfile.rb
+lib/rlzxdoc/lzxfiles.rb
 lib/rlzxdoc/version.rb
 lib/templates/class.rhtml
 lib/templates/class_list.rhtml

data/lib/rlzxdoc/lzxfiles.rb

@@ -0,0 +1,42 @@
+#
+# this class contains lzxfile classes.
+#
+#--
+# author togawa manabu (togawamanabu@gmail.com)
+
+module Rlzxdoc
+  class LzxFiles
+    include Enumerable
+
+    def initialize(locale)
+      @locale = locale
+      @lzx_classes = Array.new
+    end
+
+    def add(lzxfile_path)
+      p = LzxFile.new(lzxfile_path, @locale)
+      p.class_list.each{ |lzxclass|
+        lzxclass.hierarchy_depths = lzxfile_path.split("/").length
+        @lzx_classes << { :path => lzxfile_path, :class => lzxclass}
+      }
+    end
+
+    def [](index)
+      @lzx_classes[index]
+    end
+
+    def size
+      @lzx_classes.size
+    end
+
+    def each()
+      @lzx_classes.each{ |lzxclass|
+        yield(lzxclass)
+      }
+    end
+
+    def sort_by_path
+      @lzx_classes.sort!{ |a, b| a[:path] <=> b[:path]}
+    end
+  end
+end

data/lib/rlzxdoc/version.rb

@@ -2,7 +2,7 @@ module Rlzxdoc #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/rlzxdoc.rb

@@ -21,6 +21,7 @@ require "rdoc/usage"
 
 require "rlzxdoc/lzxclass"
 require "rlzxdoc/lzxfile"
+require "rlzxdoc/lzxfiles"
 
 module Rlzxdoc
   # main
@@ -33,7 +34,7 @@ module Rlzxdoc
 
     @rlzxdoc_root = File.dirname(File.expand_path(__FILE__))
 
-    @lzx_classes = Array.new
+    @lzx_classes = LzxFiles.new(@locale)
 
     expand_outputdir = File.expand_path(@outputdir)
 
@@ -46,12 +47,12 @@ module Rlzxdoc
 
     Dir::chdir(@basedir)
 
-    Dir::glob("*.lzx").each{ |lzxfile| add_class_from_lzx(lzxfile) }
+    Dir::glob("*.lzx").each{ |lzxfile| @lzx_classes.add(lzxfile) }
 
     Dir::glob("**/").each { |dir|
       unless @exceptdirs.include?(File.dirname(dir).split("/").last)
         Dir::glob("#{dir}*.lzx").each {|lzxfile|
-          Rlzxdoc.add_class_from_lzx(lzxfile)
+          @lzx_classes.add(lzxfile)
         }
       end
     }
@@ -82,17 +83,8 @@ module Rlzxdoc
     nav_erb = File.open(@rlzxdoc_root + '/templates/nav.rhtml') {|f| ERB.new(f.read)}
     File.open("#{expand_outputdir}/nav.html", "w"){ |file| file.puts nav_erb.result(binding)}
 
-    #create class list html
+    #create class list
     class_list_erb = File.open(@rlzxdoc_root + '/templates/class_list.rhtml') { |f| ERB.new(f.read)}
     File.open("#{expand_outputdir}/classlist.html", "w"){ |file| file.puts class_list_erb.result(binding)}
   end
-
-  private
-  def Rlzxdoc.add_class_from_lzx(lzxfile_path)
-    p = LzxFile.new(lzxfile_path, @locale)
-    p.class_list.each{ |lzxclass|
-      lzxclass.hierarchy_depths = lzxfile_path.split("/").length
-      @lzx_classes << { :path => lzxfile_path, :class => lzxclass}
-    }
-  end
 end

data/lib/templates/nav.rhtml

@@ -17,9 +17,9 @@
             <li>
               <a target="content" href="classlist.html">Top</a>
             </li>
-            <% @nav.each do |title, docs| %>
+            <% @nav.sort{ |a, b| a[0] <=> b[0] }.each do |title, docs| %>
             <li><%= title %><ul>
-                <% docs.each do |doc| %>
+                <% docs.sort{ |a, b| a[:title] <=> b[:title] }.each do |doc| %>
                 <li>
                   <a target="content" href="<%= doc[:url] %>"><%= doc[:title] %></a>
                 </li>

data/test/lzx/test1/class2.lzx

@@ -1,37 +1,6 @@
 <library>
   <!--- class comment -->
-  <class name="class2" extends="view">
-    <!--- a1 comment -->
-    <attribute name="a1" value="t1" />
-    <!--- @keywords private    private -->
-    <attribute name="a2" value="t2" />
-    <!-- no doc comment -->
-    <attribute name="a3" value="t3" />
-
-    <!--- e1 event -->
-    <event name="e1" />
-
-    <!--- @keywords private private -->
-    <event name="e2" />
-
-    <!--- v1 comment -->
-    <view name="v1" />
-
-    <!--- @keywords private private -->
-    <view name="v2" />
-
-    <!--- m1 method -->
-    <method name="m1" args="val1, val2">
-    </method>
-
-    <!--- @keywords private private -->
-    <method name="m2">
-    </method>
-
-    <handler name="h1">
-    </handler>
-
-    <handler name="h2">
-    </handler>
-  </class>
+  <class name="class2" extends="view" />
+  <class name="class3" />
+  <class name="class4" />
 </library>

data/test/test_multiclass.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'pp'
+
+class TestMultiClass < Test::Unit::TestCase
+  def setup
+    @lzx_classes2 = Rlzxdoc::LzxFiles.new('ja')
+    @lzx_classes2.add("#{File.dirname(__FILE__)}/lzx/test2/class5.lzx")
+    @lzx_classes2.add("#{File.dirname(__FILE__)}/lzx/test2/aaa/class6.lzx")
+    @lzx_classes2.add("#{File.dirname(__FILE__)}/lzx/test1/class1.lzx")
+  end
+
+  def test_class
+    assert_equal(3, @lzx_classes2.size)
+  end
+
+  def test_sort_by_path
+    assert_equal("class5", @lzx_classes2[0][:class].classname)
+    assert_equal("class6", @lzx_classes2[1][:class].classname)
+    assert_equal("class1", @lzx_classes2[2][:class].classname)
+
+    @lzx_classes2.sort_by_path
+
+    assert_equal("class1", @lzx_classes2[0][:class].classname)
+    assert_equal("class6", @lzx_classes2[1][:class].classname)
+    assert_equal("class5", @lzx_classes2[2][:class].classname)
+  end
+end

data/test/test_rlzxdoc.rb

@@ -1,16 +1,16 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestLzxFile < Test::Unit::TestCase
+class TestRlzxdoc < Test::Unit::TestCase
   def setup
-    @lzxclass = Rlzxdoc::LzxFile.new("#{File.dirname(__FILE__)}/lzx/test1/class1.lzx", 'ja').class_list
-    @class1 = @lzxclass[0]
+    @lzx_classes = Rlzxdoc::LzxFiles.new('ja')
+    @lzx_classes.add("#{File.dirname(__FILE__)}/lzx/test1/class1.lzx")
+
+    @class1 = @lzx_classes[0][:class]
   end
 
   def test_class
-    assert_not_nil(@lzxclass)
-    assert(@lzxclass.size == 1)
+    assert_equal(1 , @lzx_classes.size)
 
-    assert_equal(1, @lzxclass.size)
     assert_equal("class1", @class1.classname,  "class name")
     assert_equal("class comment", @class1.classcomment, "class comment")
     assert_equal("view", @class1.extends)

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>rlzxdoc</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/rlzxdoc"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/rlzxdoc" class="numbers">0.0.1</a>
+      <a href="http://rubyforge.org/projects/rlzxdoc" class="numbers">0.0.2</a>
     </div>
     <h1>&#x2192; &#8216;rlzxdoc&#8217;</h1>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rlzxdoc
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ""
 authors: 
 - togawa manabu
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-14 00:00:00 +09:00
+date: 2008-03-24 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,7 @@ files:
 - lib/rlzxdoc.rb
 - lib/rlzxdoc/lzxclass.rb
 - lib/rlzxdoc/lzxfile.rb
+- lib/rlzxdoc/lzxfiles.rb
 - lib/rlzxdoc/version.rb
 - lib/templates/class.rhtml
 - lib/templates/class_list.rhtml
@@ -92,4 +93,5 @@ specification_version: 2
 summary: lzxdoc tool by
 test_files: 
 - test/test_helper.rb
+- test/test_multiclass.rb
 - test/test_rlzxdoc.rb