docbook_status 0.3.0 → 0.4.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.4.0 / 2011-10-??
+
+* Minor changes
+** The word counts displayed are now the totals of the respective section, including all its children
+** Changed remarks output, more space for file names and content
+** Changed the homepage to GitHub
+
 == 0.3.0 / 2011-09-28
 
 * Writing goals (total and daily) can be defined and tracked

data/README.rdoc

@@ -1,6 +1,6 @@
 = docbook_status
 
-A utility for DocBook authors/publishers showing the document structure (sections) and word count of a DocBook project. It is intended to provide an overview of a DocBook project's structure and volume while you are writing or editing it.
+A utility for DocBook authors/publishers showing the document structure (sections) and word count of a DocBook project. It is intended to provide an overview of a DocBook project's structure and size while you are writing or editing it.
 
 == Features
 
@@ -13,9 +13,9 @@ A utility for DocBook authors/publishers showing the document structure (section
 
 == Synopsis
 
-docbook_status is mainly a comandline application, bin/docbook_status, that helps with writing and editing DocBook 5 documents. The application provides information about the content of a DocBook project. That project can consist of a single file or of several files that are included in the master file via XInclude.
+docbook_status is mainly a comandline application, bin/docbook_status, which helps with writing and editing DocBook 5 documents. The application provides information about the content of a DocBook project. That project can consist of a single file or of several files that are included in the master file via XInclude.
 
-To run docbook_status manually:
+To run docbook_status once, manually:
 
    docbook_status myproject.xml
 
@@ -116,6 +116,10 @@ https://rubygems.org/gems/docbook_status
 
 * gem install docbook_status
 
+== Homepage
+
+http://rvolz.github.com/docbook_status/
+
 == License
 
 The MIT License

data/Rakefile

@@ -12,7 +12,7 @@ Bones {
   name     'docbook_status'
   authors  'Rainer Volz'
   email    'dev@textmulch.de'
-  url      'http://projekte.textmulch.de/docbook_status/'
+  url      'http://rvolz.github.com/docbook_status/'
   depend_on     'directory_watcher'
   depend_on     'libxml-ruby'
   depend_on     'json'

data/bin/docbook_status

@@ -168,10 +168,11 @@ def output_terminal(doc_info)
   if doc_info[:remarks]
     puts
     puts "Remarks".bold
-    puts "%-10s %10s %5s %-52s" % %w[Type File Line Content]
+    puts "%-10.10s %20.20s %5s %-52s" % %w[Type File Line Content]
     puts "-"*80
     doc_info[:remarks].each do |r|
-      puts "%-10.10s %10s %5d %-52.52s" % ["#{r[:keyword]}",r[:file],r[:line],r[:text]]
+      puts "%-10.10s %20.20s %5d %-42.42s" % ["#{r[:keyword]}",r[:file],r[:line],r[:text]]
+      puts "%s %-42.42s" % [' '*37,r[:text][42..84]] if r[:text].length > 42
     end
   end
 end

data/lib/docbook_status/status.rb

@@ -205,6 +205,34 @@ module DocbookStatus
      end
    end
 
+   # Helper for sum_sections
+   def sum_lower_sections(secs,start,level)
+     i=start
+     sum = 0
+     while (i < secs.length && secs[i][:level] > level)
+       sum += secs[i][:words]
+       i += 1
+     end
+     [sum,i]
+   end
+
+   # Sum the word counts of lower sections
+   def sum_sections(secs, max_level)
+     0.upto(max_level) do |cur_level|
+       i = 0
+       while i < secs.length
+         if (secs[i][:level] == cur_level)
+           (ctr,ni) = sum_lower_sections(secs, i+1,cur_level)
+           secs[i][:swords] = ctr
+           i = ni
+         else
+           i += 1
+         end
+       end
+     end
+     secs
+   end
+
    # Searches the XML document for sections and word counts. Returns an
    # array of sections (map) with title, word count, section level and DocBook tag.
    #
@@ -218,8 +246,8 @@ module DocbookStatus
      section_type = doc_maps[0][:name]
      section_ctr = 0
      section_level = 0
+     max_section_level = 0
      doc_ctr = 0
-     #puts doc_maps.inspect
      xms = doc_maps.drop(1)
      # Compute word counts per section
      xms.each do |m|
@@ -231,12 +259,17 @@ module DocbookStatus
          section_name = m[:title]
          section_ctr = 0
          section_level = m[:level]
+         max_section_level = m[:level] if (m[:level] > max_section_level)
          section_type = m[:name]
        end
      end
      @sections << {:title => section_name, :words => section_ctr, :level => section_level, :tag => section_type}
-     # Put the document word count near the document type
-     @sections[0][:words] = doc_ctr
+     # OPTIMIZE Not nice, but works
+     @sections = sum_sections(@sections,max_section_level).map {|s|
+       s[:words] = s[:words]+s[:swords];
+       s.delete(:swords)
+       s
+     }
      @sections
    end
 
@@ -246,7 +279,7 @@ module DocbookStatus
    #
    def analyze_file
      full_name = File.expand_path(@source)
-     changed  = File.ctime(@source)
+     changed  = File.mtime(@source)
      @doc = XML::Document.file(@source)
      raise ArgumentError, "Error: #{@source} is apparently not DocBook 5." unless is_docbook?(@doc)
      @doc.xinclude if has_xinclude?(@doc)

data/test/test_docbook_status.rb

@@ -43,6 +43,38 @@ EOI
                          {:title => 'S1', :words => 17, :level => 1, :tag => 'section'}])
   end
 
+  it "sums simple sections" do
+    ss = [{:level => 0, :words => 10},
+          {:level => 1, :words => 10},
+          {:level => 1, :words => 10}
+         ]
+    dbs = DocbookStatus::Status.new()
+    sse = dbs.sum_sections(ss,1)
+    sse.must_equal([{:level => 0, :words => 10, :swords => 20},
+                    {:level => 1, :words => 10, :swords => 0},
+                    {:level => 1, :words => 10, :swords => 0}
+                   ])
+  end
+
+  it "sums sections" do
+    ss = [{:level => 0, :words => 10},
+          {:level => 1, :words => 10},
+          {:level => 2, :words => 10},
+          {:level => 2, :words => 10},
+          {:level => 3, :words => 10},
+          {:level => 1, :words => 10}
+         ]
+    dbs = DocbookStatus::Status.new()
+    sse = dbs.sum_sections(ss,3)
+    sse.must_equal([{:level => 0, :words => 10, :swords => 50},
+                    {:level => 1, :words => 10, :swords => 30},
+                    {:level => 2, :words => 10, :swords => 0},
+                    {:level => 2, :words => 10, :swords => 10},
+                    {:level => 3, :words => 10, :swords => 0},
+                    {:level => 1, :words => 10, :swords => 0}
+                   ])
+  end
+
   it "processes includes" do
     dbs = DocbookStatus::Status.new()
     ind = XML::Document.file('test/fixtures/book.xml')
@@ -59,7 +91,7 @@ EOI
     dbs = DocbookStatus::Status.new('test/fixtures/book.xml')
     info = dbs.analyze_file
     info[:file].must_equal(File.expand_path('.')+'/test/fixtures/book.xml')
-    #info[:modified].to_s.must_equal('2011-09-27 18:17:10 +0200')
+    #info[:modified].to_s.must_equal('2011-09-09 18:20:15 +0200')
   end
 
   it "filters remarks while counting" do

data/version.txt

@@ -1 +1 @@
-0.3.0
+0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_status
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-28 00:00:00.000000000Z
+date: 2011-10-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: directory_watcher
-  requirement: &2154663180 !ruby/object:Gem::Requirement
+  requirement: &2165156720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *2154663180
+  version_requirements: *2165156720
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2154662400 !ruby/object:Gem::Requirement
+  requirement: &2165156200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *2154662400
+  version_requirements: *2165156200
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2154661680 !ruby/object:Gem::Requirement
+  requirement: &2165155600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2154661680
+  version_requirements: *2165155600
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &2154660920 !ruby/object:Gem::Requirement
+  requirement: &2165154960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *2154660920
+  version_requirements: *2165154960
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2154660120 !ruby/object:Gem::Requirement
+  requirement: &2165154300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *2154660120
+  version_requirements: *2165154300
 description: A utility for DocBook authors/publishers showing the document structure
   (sections) and word count of a DocBook project. It is intended to provide an overview
-  of a DocBook project's structure and volume while you are writing or editing it.
+  of a DocBook project's structure and size while you are writing or editing it.
 email: dev@textmulch.de
 executables:
 - docbook_status
@@ -100,7 +100,7 @@ files:
 - test/test_docbook_status.rb
 - test/test_history.rb
 - version.txt
-homepage: http://projekte.textmulch.de/docbook_status/
+homepage: http://rvolz.github.com/docbook_status/
 licenses: []
 post_install_message: 
 rdoc_options: