docbook_status 0.1.0

data/.bnsignore

@@ -0,0 +1,18 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   Bones {
+#     ignore_file  '.gitignore'
+#   }
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+gem "libxml-ruby", "~> 2.2.2", :require => 'xml'
+gem "directory_watcher"
+
+group :development do
+	gem "bones"
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    directory_watcher (1.4.1)
+    hoe (2.12.3)
+      rake (~> 0.8)
+    libxml-ruby (2.2.2)
+    rake (0.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  directory_watcher
+  hoe
+  libxml-ruby (~> 2.2.2)

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 2011-09-07
+
+* Initial version
+

data/README.txt

@@ -0,0 +1,59 @@
+= 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.
+
+	
+== Features
+
+* lists all sections (set, book, ... section, simplesect) in a DocBook file
+* calculates a word count for each section (words in paras, simparas and formalparas)
+* works with included sections (XInclude)
+
+== Examples
+
+The package includes a comandline application, bin/docbook_status, that can be used in two ways:
+
+to run it manually, once:
+   docbook_status <DocBook file>
+
+to run the application in demon mode, continually:
+   docbook_status --demon --glob "*.xml" --dir "." <DocBook file>
+   
+In demon-mode the application checks the files matched by the _glob_ pattern in the directory specified by _dir_ for changes, and redisplays the document analysis whenever a change occures. The demon can be termanted by simply pressing RETURN. 
+
+== Download
+
+https://rubygems.org/gem/docbook_status
+
+== Requirements
+
+* libxml2
+
+== Install
+
+* gem install docbook_status
+
+== License
+
+The MIT License
+
+Copyright (c) 2011 Rainer Volz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,17 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
+
+Bones {
+  name     'docbook_status'
+  authors  'Rainer Volz'
+  email    'dev@textmulch.de'
+  url      'http://projekte.textmuch.de/docbook_status/'
+}
+

data/bin/docbook_status

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# -*-encoding:utf-8 ; mode:ruby-*-
+##
+# docbook_status is the commandline application for the library.
+# Its main purpose is to display the structure and word counts for DocBook 5 documents.
+# docbook_status can be used in single-run mode or demon-mode. In demon_mode it stays active
+# and looks for changes in the filesystem.
+#
+
+require 'rubygems'
+require "bundler/setup"
+require 'optparse'
+require 'directory_watcher'
+
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib docbook_status]))
+
+@demon = false
+@glob = '*.xml'
+@dir = '.'
+@pre = []
+banner = <<EOB
+docbook_status, Version #{DocbookStatus.version}
+
+Display DocBook 5 document structure and word counts.
+
+Usage: docbook_status [--demon] [--glob <PATTERN>] [--dir <DIR>] [--pre COMMAND] <DOCBOOK-FILE>
+EOB
+
+opts = OptionParser.new
+opts.banner = banner
+opts.on('--demon', 'Keep running, act when files change') {|val| @demon = true}
+opts.on('--glob PATTERN', String, 'File mask for demon mode, default = "*.xml"') {|val| @glob = val}
+opts.on('--dir DIR', String, 'Source directory for demon mode, default = "." ') {|val| @dir = val}
+opts.on('--pre COMMAND', String, 'A shell command that should be executed before') {|val| @pre << val}
+rest = opts.parse(ARGV)
+
+def run(file)
+  @pre.each {|cmd| system(cmd)}
+  doc = XML::Document.file(file)
+  dbs = DocbookStatus.new
+  if !dbs.is_docbook?(doc)
+    puts "Error: #{file} is apparently not DocBook 5."
+    return
+  end
+  doc.xinclude if dbs.has_xinclude?(doc)
+  sections = dbs.analyze_document(doc)
+  puts
+  puts "File:               #{file}"
+  puts "Modified:           #{File.ctime(file)}"
+  puts "Document structure:"
+  puts "%-50.50s %-16s %5s" % ['Title','Tag','Words']
+  puts "-"*73
+  sections.each do |s|
+    puts "%-50.50s %-16s %5d" % [(' ' * s[2])+s[0], s[3], s[1]]
+  end
+end
+
+def demon(file)
+  dw = DirectoryWatcher.new @dir, :glob => @glob, :pre_load => true
+  dw.interval = 5.0
+  dw.stable = 2
+  dw.persist = "dw_state.yml"
+  dw.add_observer {|*args|
+    args.each {|event|
+      #puts event
+      if event.type == :stable
+        run(file)
+      end
+    }
+  }
+  dw.start    # loads state from dw_state.yml
+  STDIN.gets  # when the user hits "enter" the script will terminate
+  dw.stop     # stores state to dw_state.yml
+end
+
+# Print banner if called without arguments
+if rest.length < 1
+  puts opts.to_s
+  exit 1
+end
+
+puts("docbook_status, Version #{DocbookStatus.version}")
+run(rest[0])
+if (@demon)
+  demon(rest[0])
+end
+exit 0

data/docbook_status.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{docbook_status}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rainer Volz"]
+  s.date = %q{2011-09-08}
+  s.default_executable = %q{docbook_status}
+  s.description = %q{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.}
+  s.email = %q{dev@textmulch.de}
+  s.executables = ["docbook_status"]
+  s.extra_rdoc_files = ["History.txt", "README.txt", "bin/docbook_status"]
+  s.files = [".bnsignore", "Gemfile", "Gemfile.lock", "History.txt", "README.txt", "Rakefile", "bin/docbook_status", "lib/docbook_status.rb", "spec/docbook_status_spec.rb", "spec/spec_helper.rb", "test/fixtures/book.xml", "test/fixtures/chapter2.xml", "test/test_docbook_status.rb", "version.txt"]
+  s.homepage = %q{http://projekte.textmuch.de/docbook_status/}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{docbook_status}
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A utility for DocBook authors/publishers showing the document structure (sections) and word count of a DocBook project.}
+  s.test_files = ["test/test_docbook_status.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bones>, [">= 3.7.1"])
+    else
+      s.add_dependency(%q<bones>, [">= 3.7.1"])
+    end
+  else
+    s.add_dependency(%q<bones>, [">= 3.7.1"])
+  end
+end

data/lib/docbook_status.rb

@@ -0,0 +1,143 @@
+# -*- encoding: utf-8 -*-
+
+require 'xml'
+
+# Analyzes DocBook 5 documents for document structure (sections) and text length.
+#
+class DocbookStatus
+
+  # :stopdoc                  
+  #
+  PATH = File.expand_path('../..', __FILE__) + File::SEPARATOR
+  LIBPATH = File.expand_path('..', __FILE__) + File::SEPARATOR
+  VERSION = File.read(PATH + '/version.txt').strip
+  HOME = File.expand_path(ENV['HOME'] || ENV['USERPROFILE'])
+  #
+  # :startdoc
+
+  # The DocBook 5 namespace URL
+  DOCBOOK_NS = 'http://docbook.org/ns/docbook'
+  # The XInclude namespace URL
+  XINCLUDE_NS = 'http://www.w3.org/2001/XInclude'
+
+  # Elements whose contents is counted as text
+  @@text_elements = ['para','simpara','formalpara']
+
+  # Section elements, following the list given in http://docbook.org/tdg5/en/html/ch02.html#roots
+  # except for the refsect... elements. 
+  @@section_elements = %w[
+    acknowledgements appendix article 
+    bibliography book 
+    chapter colophon 
+    dedication 
+    glossary 
+    index
+    preface  
+    section sect1 sect2 sect3 sect4 set simplesect 
+    toc 
+  ]
+
+  def initialize
+    @sections = []
+  end
+
+  # Returns the version of docbook_status
+  #
+  def self.version
+    VERSION
+  end  
+
+  # Counts the words in the contents of the given node. _Word_ in this  
+  # context means something that is delimited by _space_ charactes and starts with 
+  # _word_ characters (in the regexp sense).
+  #
+  def count_words(node)
+    words = node.content.strip.split(/[[:space:]]+/).find_all {|w| w =~ /\w+/}
+    words.size
+  end
+
+  # Find the _title_ of the current section. That element is either
+  # directly following or inside an _info_ element. Return the empty
+  # string if no title can be found.
+  #
+  def find_section_title(node)
+    title = node.find_first('./db:title')
+    if title.nil?
+      title = node.find_first './db:info/db:title'
+    end
+    if title.nil?
+      ""
+    else
+      title.content
+    end
+  end
+
+  # Check the document elements for content and type recursively,
+  # starting at the current node.  Returns an array with paragraph and
+  # section maps.                         
+  #
+  def check_node(node, level, ctr)
+    if (@@text_elements.include? node.name)
+      ctr << {:type => :para, :level => level, :words => count_words(node)}
+    elsif (@@section_elements.include? node.name)
+      title = find_section_title(node)
+      ctr << {:type => :section, :level => level, :title => title, :name => node.name}
+    end
+    node.children.each {|inner_elem| check_node(inner_elem, level+1, ctr)} if node.children?
+    ctr
+  end
+
+  # Check whether the document has a DocBook default namespace
+  def is_docbook?(doc)
+    dbns = doc.root.namespaces.default
+    (!dbns.nil? && (dbns.href.casecmp(DOCBOOK_NS) == 0))
+  end
+
+  # Check whether the document has a XInclude namespace
+  def has_xinclude?(doc)
+    ret = false
+    doc.root.namespaces.each do |ns|
+      if (ns.href.casecmp(XINCLUDE_NS) == 0)
+        ret = true
+        break
+      end
+    end
+    ret
+  end
+
+  # Searches the XML document for sections and word counts. Returns an
+  # array of sections with their word counts.
+  #
+  def analyze_document(doc)
+    # Add a namespace declaration for XPath expressions
+    doc.root.namespaces.default_prefix = 'db'
+    # Analyze the document starting with the root node
+    doc_maps = check_node(doc.root,0,[])
+    @sections = []
+    section_name = doc_maps[0][:title]
+    section_type = doc_maps[0][:name]
+    section_ctr = 0
+    section_level = 0
+    doc_ctr = 0
+    #puts doc_maps.inspect
+    xms = doc_maps.drop(1)
+    # Compute word counts per section
+    xms.each do |m|
+      if (m[:type] == :para)
+        doc_ctr += m[:words]
+        section_ctr += m[:words]
+      else
+        @sections << [section_name,section_ctr,section_level,section_type]
+        section_name = m[:title]
+        section_ctr = 0
+        section_level = m[:level]
+        section_type = m[:name]
+      end
+    end
+    @sections << [section_name,section_ctr,section_level,section_type]
+    # Put the document word count near the document type
+    @sections[0][1] = doc_ctr
+    @sections
+  end
+
+end

data/spec/docbook_status_spec.rb

@@ -0,0 +1,6 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe DocbookStatus do
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib docbook_status]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+

data/test/fixtures/book.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<book xmlns="http://docbook.org/ns/docbook" 
+	xmlns:xi="http://www.w3.org/2001/XInclude"
+	version="5.0">
+  <title>B1</title>
+  <chapter>
+    <title>C1</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    </para>
+  </chapter>
+  <xi:include href="chapter2.xml"/>
+</book>

data/test/fixtures/chapter2.xml

@@ -0,0 +1,7 @@
+  <chapter xmlns="http://docbook.org/ns/docbook" version="5.0">
+    <title>C2</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    </para>
+  </chapter>

data/test/test_docbook_status.rb

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+require 'minitest/spec'
+require 'minitest/autorun'
+require "docbook_status"
+
+describe DocbookStatus do
+  it "works" do
+    true
+  end
+
+  it "complains if the input is not DocBook 5" do
+    non5 = XML::Document.string '<?xml version="1.0"?><article/>'
+    dbs = DocbookStatus.new()
+    status = dbs.is_docbook?(non5)
+    status.must_be :==, false
+  end
+
+  it "input is DocBook 5" do
+    non5 = XML::Document.string '<?xml version="1.0"?><article xmlns="http://docbook.org/ns/docbook"/>'
+    dbs = DocbookStatus.new()
+    status = dbs.is_docbook?(non5)
+    status.must_be :==, true
+  end
+
+  it "counts correctly" do
+    input = <<EOI
+<?xml version="1.0" ?>
+<article xmlns="http://docbook.org/ns/docbook" version="5.0">
+  <title>A1</title>
+  <section>
+    <title>S1</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    </para>
+  </section>
+</article>
+EOI
+    dbs = DocbookStatus.new()
+    ind = XML::Document.string(input)
+    sections = dbs.analyze_document(ind)
+    sections.must_equal([['A1', 17, 0, 'article'],['S1', 17, 1, 'section']])
+  end
+
+  it "processes includes" do
+    dbs = DocbookStatus.new()
+    ind = XML::Document.file('test/fixtures/book.xml')
+    if (dbs.has_xinclude?(ind))
+      ind.xinclude
+    end
+    sections = dbs.analyze_document(ind)
+    sections.must_equal([['B1', 34, 0, 'book'],['C1', 17, 1, 'chapter'],['C2', 17, 1, 'chapter']])
+  end
+
+end

data/version.txt

@@ -0,0 +1 @@
+0.1.0

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: docbook_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rainer Volz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-08 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bones
+  requirement: &2169388760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+  type: :development
+  prerelease: false
+  version_requirements: *2169388760
+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.
+email: dev@textmulch.de
+executables:
+- docbook_status
+extensions: []
+extra_rdoc_files:
+- History.txt
+- README.txt
+- bin/docbook_status
+files:
+- .bnsignore
+- Gemfile
+- Gemfile.lock
+- History.txt
+- README.txt
+- Rakefile
+- bin/docbook_status
+- docbook_status.gemspec
+- lib/docbook_status.rb
+- spec/docbook_status_spec.rb
+- spec/spec_helper.rb
+- test/fixtures/book.xml
+- test/fixtures/chapter2.xml
+- test/test_docbook_status.rb
+- version.txt
+has_rdoc: true
+homepage: http://projekte.textmuch.de/docbook_status/
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: docbook_status
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A utility for DocBook authors/publishers showing the document structure (sections)
+  and word count of a DocBook project.
+test_files:
+- test/test_docbook_status.rb