docbook_status 0.5.0 → 1.0.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.*~
+coverage
+rdoc
+doc
+pkg
+#*.*
+/test/.DS_Store

data/History.txt

@@ -1,3 +1,9 @@
+== 1.0.0 / 2012-07-04
+
+* Updated version to 1.0, 0.5 had few and tiny bug reports 
+* Empty remarks are now properly handled and signaled.
+* Improved Ruby 1.8.7 support for status history.
+
 == 0.5.0 / 2011-10-15
 
 * Removed the daemon functionality, it didn't work across platforms. Use Guard instead.

data/README.rdoc

@@ -120,7 +120,7 @@ http://rvolz.github.com/docbook_status/
 
 The MIT License
 
-Copyright (c) 2011 Rainer Volz
+Copyright (c) 2011-12 Rainer Volz
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/docbook_status/history.rb

@@ -71,10 +71,12 @@ module DocbookStatus
 
     # Add to the history
     def add(ts,word_count)
-      # FIXME add demon mode
-      #@history[:current] << progress
-      #archive
-      k = ts.to_date
+      # Ruby 1.8 doesn't have DateTime#to_date, so we check that here
+      begin
+        k = ts.to_date
+      rescue NoMethodError
+        k = Date.parse(ts.to_s)
+      end
       unless (@history[:archive][k].nil?)
         @history[:archive][k][:min] = word_count if @history[:archive][k][:min] > word_count
         @history[:archive][k][:max] = word_count if @history[:archive][k][:max] < word_count

data/lib/docbook_status/status.rb

@@ -15,6 +15,14 @@ module DocbookStatus
    #
    XINCLUDE_NS = 'http://www.w3.org/2001/XInclude'
 
+   # Standard remark keyword, if there is none entered
+   #
+   STD_REMARK = 'REMARK'
+
+   # Standard remark text for remarks without content
+   #
+   EMPTY_REMARK = '-- EMPTY REMARK --'
+
    # Elements whose contents is counted as text. The _formalpara_
    # elements are included implicitly because they contain _para_ child
    # elements.
@@ -168,13 +176,15 @@ module DocbookStatus
      rems = doc.find('//db:remark')
      rems.map {|rem|
        c = rem.content.strip
-       kw = 'REMARK'
-       if rem.first.text?
+       kw = STD_REMARK
+       unless c.empty?
          kw1 = c.match('^([[:upper:]]+)([[:space:][:punct:]]|$)')
          unless kw1.nil?
            kw = kw1[1]
            c = kw1.post_match.lstrip
          end
+       else
+         c = EMPTY_REMARK
        end
        # TODO XPath integrieren? :path => rem.path, :parent => rem.parent.path,
        {:keyword => kw, :text => c, :file=>source, :line => rem.line_num}
@@ -182,6 +192,9 @@ module DocbookStatus
    end
 
    # Finds the remarks by looking through all the Xincluded files
+   # 
+   # The remarks returned can be filtered by keyword if an keyword array is 
+   # passed as an argument.
    #
    def find_remarks(filter=[])
      if (@source.nil?)

data/test/fixtures/book-remarks.xml

@@ -0,0 +1,29 @@
+<?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>
+    <formalpara>
+      <title>Titel</title>
+      <para>
+        <remark>Blindtext auswechseln</remark>
+        Lorem ipsum dolor sit amet, consectetuer adipiscing
+        elit. Aenean commodo ligula eget dolor. Aenean massa.
+      </para>
+    </formalpara>
+    <remark/>
+    <simpara>
+      Cum sociis natoque penatibus et magnis dis parturient montes,
+      nascetur ridiculus mus. Donec quam felis, ultricies nec,
+      pellentesque eu, pretium quis, sem.
+    </simpara>
+    <remark></remark>
+    <remark> </remark>
+  </chapter>
+</book>

data/test/test_docbook_status.rb

@@ -91,7 +91,6 @@ 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-09 18:20:15 +0200')
   end
 
   it "filters remarks while counting" do
@@ -113,10 +112,23 @@ EOI
   it "finds remarks" do
     dbs = DocbookStatus::Status.new('test/fixtures/book.xml')
     all_remarks = dbs.find_remarks
-    #all_remarks = dbs.remarks()
     all_remarks.must_equal([{:keyword=>"REMARK", :text=>"Blindtext auswechseln", :file=>"book.xml", :line=>15}, {:keyword=>"FIXME", :text=>"Ausbauen.", :file=>"chapter2.xml", :line=>6}])
     fixmes = dbs.remarks('FIXME')
     fixmes.must_equal([{:keyword=>"FIXME", :text=>"Ausbauen.", :file=>"chapter2.xml", :line=>6}])
   end
 
+  describe "with problematic remarks" do
+    it "can deal with empty remarks" do
+      dbs = DocbookStatus::Status.new('test/fixtures/book-remarks.xml')
+      all_remarks = dbs.find_remarks
+      all_remarks.length.must_equal(4)
+    end
+    it "signals empty remarks" do
+      dbs = DocbookStatus::Status.new('test/fixtures/book-remarks.xml')
+      all_remarks = dbs.find_remarks
+      empties = all_remarks.select {|r| r[:text] == DocbookStatus::Status::EMPTY_REMARK}
+      empties.length.must_equal(3)
+    end
+  end
+
 end

data/version.txt

@@ -1 +1 @@
-0.5.0
+1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_status
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-15 00:00:00.000000000Z
+date: 2012-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2167250780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *2167250780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &2167250280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,29 +37,44 @@ dependencies:
         version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2167250280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: zucker
-  requirement: &2167249780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2167249780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2167249140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.7.1
+        version: 3.8.0
   type: :development
   prerelease: false
-  version_requirements: *2167249140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 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 size while you are writing or editing it.
@@ -67,6 +87,7 @@ extra_rdoc_files:
 - README.rdoc
 - bin/docbook_status
 files:
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - History.txt
@@ -78,7 +99,7 @@ files:
 - lib/docbook_status/status.rb
 - spec/docbook_status_spec.rb
 - spec/spec_helper.rb
-- test/.DS_Store
+- test/fixtures/book-remarks.xml
 - test/fixtures/book.xml
 - test/fixtures/bookxi.xml
 - test/fixtures/chapter2.xml
@@ -110,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: docbook_status
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A utility for DocBook authors/publishers showing the document structure (sections)