docbook_status 0.1.1 → 0.3.0

data/test/fixtures/book.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<book xmlns="http://docbook.org/ns/docbook" 
+<book xmlns="http://docbook.org/ns/docbook"
 	xmlns:xi="http://www.w3.org/2001/XInclude"
 	version="5.0">
   <title>B1</title>
@@ -9,6 +9,19 @@
        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>
+    <simpara>
+      Cum sociis natoque penatibus et magnis dis parturient montes,
+      nascetur ridiculus mus. Donec quam felis, ultricies nec,
+      pellentesque eu, pretium quis, sem.
+    </simpara>
   </chapter>
   <xi:include href="chapter2.xml"/>
 </book>

data/test/fixtures/bookxi.xml

@@ -0,0 +1,15 @@
+<?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="chapter2xi.xml"/>
+  <xi:include href="chapter3xi.xml"/>
+</book>

data/test/fixtures/chapter2.xml

@@ -3,5 +3,6 @@
     <para>
        Dies ist ein Test .. Dies ist ein  Test.
        In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+       <remark>FIXME Ausbauen.</remark>
     </para>
-  </chapter>
+  </chapter>

data/test/fixtures/chapter2xi.xml

@@ -0,0 +1,11 @@
+<chapter xmlns="http://docbook.org/ns/docbook"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+           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.
+    <remark>FIXME Ausbauen.</remark>
+  </para>
+  <xi:include href="section1xi.xml"/>
+</chapter>

data/test/fixtures/chapter3xi.xml

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

data/test/fixtures/section1xi.xml

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

data/test/test_docbook_status.rb

@@ -10,14 +10,14 @@ describe DocbookStatus do
 
   it "complains if the input is not DocBook 5" do
     non5 = XML::Document.string '<?xml version="1.0"?><article/>'
-    dbs = DocbookStatus.new()
+    dbs = DocbookStatus::Status.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()
+    dbs = DocbookStatus::Status.new()
     status = dbs.is_docbook?(non5)
     status.must_be :==, true
   end
@@ -36,20 +36,55 @@ describe DocbookStatus do
   </section>
 </article>
 EOI
-    dbs = DocbookStatus.new()
+    dbs = DocbookStatus::Status.new()
     ind = XML::Document.string(input)
     sections = dbs.analyze_document(ind)
-    sections.must_equal([['A1', 17, 0, 'article'],['S1', 17, 1, 'section']])
+    sections.must_equal([{:title => 'A1', :words => 17, :level => 0, :tag => 'article'},
+                         {:title => 'S1', :words => 17, :level => 1, :tag => 'section'}])
   end
 
   it "processes includes" do
-    dbs = DocbookStatus.new()
+    dbs = DocbookStatus::Status.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']])
+    sections.must_equal([{:title => 'B1', :words => 71, :level => 0, :tag => 'book'},
+                         {:title => 'C1', :words => 54, :level => 1, :tag => 'chapter'},
+                         {:title => 'C2', :words => 17, :level => 1, :tag => 'chapter'}])
+  end
+
+  it "returns the full file name and time" do
+    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')
+  end
+
+  it "filters remarks while counting" do
+    dbs = DocbookStatus::Status.new()
+    ind = XML::Document.file('test/fixtures/chapter2.xml')
+    sections = dbs.analyze_document(ind)
+    sections.must_equal([{:title => 'C2', :words => 17, :level => 0, :tag => 'chapter'}])
+  end
+
+  it "finds and collects all XIncludes URLs in a document" do
+    dbs = DocbookStatus::Status.new()
+    ind = XML::Document.file('test/fixtures/bookxi.xml')
+    xinc = dbs.has_xinclude?(ind)
+    xinc.must_equal(true)
+    xincs = dbs.find_xincludes(ind)
+    xincs.must_equal(["chapter2xi.xml", "chapter3xi.xml", "section1xi.xml"])
+  end
+
+  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
 
 end

data/test/test_history.rb

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+require 'minitest/spec'
+require 'minitest/autorun'
+require "docbook_status"
+
+describe DocbookStatus::History do
+
+  after(:each) do
+    if File.exists?(DocbookStatus::History::HISTORY_FILE)
+      File.unlink(DocbookStatus::History::HISTORY_FILE)
+    end
+  end
+
+  it "initializes with minimal values" do
+    h = DocbookStatus::History.new('test.xml')
+    h.save
+    File.exists?(DocbookStatus::History::HISTORY_FILE).must_equal(true)
+    history = YAML.load_file(DocbookStatus::History::HISTORY_FILE)
+    history[:file].must_equal('test.xml')
+    history[:goal][:start].must_equal(Date.today)
+    history[:goal][:end].must_equal(nil)
+    history[:goal][:goal_total].must_equal(0)
+    history[:goal][:goal_daily].must_equal(0)
+  end
+
+  it "initializes with all values" do
+    h = DocbookStatus::History.new('test.xml',Date.today+10,10000,1000)
+    h.save
+    File.exists?(DocbookStatus::History::HISTORY_FILE).must_equal(true)
+    history = YAML.load_file(DocbookStatus::History::HISTORY_FILE)
+    history[:file].must_equal('test.xml')
+    history[:goal][:start].must_equal(Date.today)
+    history[:goal][:end].must_equal(Date.today+10)
+    history[:goal][:goal_total].must_equal(10000)
+    history[:goal][:goal_daily].must_equal(1000)
+    h.goals.must_equal({:start => Date.today, :end=>Date.today+10, :goal_total => 10000, :goal_daily=>1000})
+  end
+
+  it "knows when the history file exists" do
+    DocbookStatus::History.exists?.must_equal(false)
+    h = DocbookStatus::History.new('test.xml')
+    h.save
+    DocbookStatus::History.exists?.must_equal(true)
+  end
+
+  it "progress can be added" do
+    h = DocbookStatus::History.new('test.xml')
+    h.history?.must_equal(false)
+    h.add(DateTime.now,100)
+    h.history?.must_equal(true)
+    h.today.must_equal({:min => 100, :max => 100, :start=>100, :end => 100, :ctr => 1})
+    # add one word
+    h.add(DateTime.now,101)
+    h.today.must_equal({:min => 100, :max => 101, :start=>100, :end => 101, :ctr => 2})
+    # subtract two words
+    h.add(DateTime.now,99)
+    h.today.must_equal({:min => 99, :max => 101, :start=>100, :end => 99, :ctr => 3})
+    # add a progress from yesterday that should be ignored
+    h.add(DateTime.now()-1,10)
+    h.today.must_equal({:min => 99, :max => 101, :start=>100, :end => 99, :ctr => 3})
+  end
+
+  it "stores progress" do
+    h = DocbookStatus::History.new('test.xml')
+    h.history?.must_equal(false)
+    h.add(DateTime.now,100)
+    h.add(DateTime.now,101)
+    h.add(DateTime.now,99)
+    h.save
+    h = nil
+    i = DocbookStatus::History.new('test.xml')
+    i.today.must_equal({:min => 99, :max => 101, :start=>100, :end => 99, :ctr => 3})
+  end
+end

data/version.txt

@@ -1 +1 @@
-0.1.1
+0.3.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_status
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,55 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-08 00:00:00.000000000 +02:00
-default_executable: 
+date: 2011-09-28 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: directory_watcher
+  requirement: &2154663180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154663180
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: &2154662400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154662400
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2154661680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154661680
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: &2154660920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154660920
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2166328320 !ruby/object:Gem::Requirement
+  requirement: &2154660120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +65,7 @@ dependencies:
         version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *2166328320
+  version_requirements: *2154660120
 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.
@@ -32,30 +75,37 @@ executables:
 extensions: []
 extra_rdoc_files:
 - History.txt
-- README.txt
+- README.rdoc
 - bin/docbook_status
 files:
 - .bnsignore
 - Gemfile
 - Gemfile.lock
 - History.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - bin/docbook_status
 - lib/docbook_status.rb
+- lib/docbook_status/history.rb
+- lib/docbook_status/status.rb
 - spec/docbook_status_spec.rb
 - spec/spec_helper.rb
+- test/.DS_Store
 - test/fixtures/book.xml
+- test/fixtures/bookxi.xml
 - test/fixtures/chapter2.xml
+- test/fixtures/chapter2xi.xml
+- test/fixtures/chapter3xi.xml
+- test/fixtures/section1xi.xml
 - test/test_docbook_status.rb
+- test/test_history.rb
 - version.txt
-has_rdoc: true
 homepage: http://projekte.textmulch.de/docbook_status/
 licenses: []
 post_install_message: 
 rdoc_options:
 - --main
-- README.txt
+- README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -72,10 +122,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: docbook_status
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 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
+- test/test_history.rb

data/README.txt

@@ -1,59 +0,0 @@
-= 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/gems/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.