docbook_status 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff89229faac026ad1c014784ae685be82f095c203c887215923b039207913284
+  data.tar.gz: 06b33266a54dcbe668988f95645e46380bac5baf51e967f2adc40bdb476bad39
+SHA512:
+  metadata.gz: a5fbe0c7273333071059feedfc66c0aae8345de3ebae29fc9fddcb582a16e49769467ceae52b42e9613aa858ccfea8d230f37499ecfd68d9d067ed1277aeb4c5
+  data.tar.gz: 7eb5937444ad99cb1f58c3d4d7ac76567f6c627bbcbed87bf28e0826b3388ba47959662a05e8ee78d0a6d05cdaa54a160f213643ba73c2afc372d7d8b123ecf0

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+* Updated dependencies for Ruby 2.5
+* Updated tests
+
+## [1.0.1] - 2012-12-23
+
+* Updated documentation url
+
+## [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.
+* Improved the platform compatibility. Should now work better on Windows.
+* Color support is now optional on Windows. Is switched on if gem 'win32console' is available.
+* JSON support is now optional. Is switched on if the json library (1.9) or gem (1.8) is available.
+
+## [0.4.0] - 2011-10-04
+
+* 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
+* Added YAML and JSON output formats, available with option --outputformat
+* Minor fixes
+  * Removed daemon state persistence file dw_state.yml
+  * Colorized screen output
+  * Reorganized library
+
+## [0.2.1] - 2011-09-18
+
+* Minor fixes for Gem packaging
+
+## [0.2.0] - 2011-09-18
+
+* Added remarks listing.
+* Minor fixes
+  * removed _formalpara_ from the list of countable text elements because they contain _para_ elements
+
+## [0.1.1] - 2011-09-07
+
+* Documentation corrections
+
+## 0.1.0 / 2011-09-07
+
+* Initial version

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright © 2011-19 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/{README.rdoc → README.md}

@@ -1,8 +1,8 @@
-= docbook_status
+# 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 size while you are writing or editing it.
 
-== Features
+## Features
 
 * lists the section hierarchy (set, book, ... section, simplesect) of a DocBook file
 * calculates a word count for each section (words in paras, simparas and formalparas)
@@ -11,116 +11,116 @@ A utility for DocBook authors/publishers showing the document structure (section
 * output in YAML and JSON format (optional)
 * tracks writing progress
 
-== Synopsis
+## Synopsis
 
 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:
 
-   docbook_status myproject.xml
+   `docbook_status myproject.xml`
 
 This will show the section hierarchy and the word count of the individual sections of myproject.xml.
 
 If the file contains editing remarks, you could list them, too:
 
-   docbook_status --remarks myproject.xml
+   `docbook_status --remarks myproject.xml`
 
 Here docbook_status looks for all _remark_ elements. The application uses the same convention as many source code tools: if the content of the remark element starts with a all-uppercase word, like FIXME or TODO, this will be listed as the remark type, otherwise just REMARK will be used.
 
 If there are many remarks and you just want to concentrate on the most important ones, let's say the FIXMEs, you could restrict the listing with:
 
-   docbook_status --remarks=FIXME myproject.xml
+   `docbook_status --remarks=FIXME myproject.xml`
 
 If you need to preprocess the XML before feeding it to docbook_status, there is an option for that:
 
-   docbook_status --pre "asciddoc -bdocbook50 myproject.txt" myproject.xml
+   `docbook_status --pre "asciddoc -bdocbook50 myproject.txt" myproject.xml`
 
 --pre takes shell commands as arguments and executes them before starting the analysis on the XML file.
 
-== Tracking writing progress
+## Tracking writing progress
 
 As an experiment docbook_status provides features to define and track writing goals/schedules. Currently there are the following options:
 
-* an end date, or deadline, with option --end=[YYYY-MM-DD]
-* a total word count goal, with option --total=[number]
-* a daily word count goal, with option --daily=[number]
+* an end date, or deadline, with option --end=\[YYYY-MM-DD\]
+* a total word count goal, with option --total=\[number\]
+* a daily word count goal, with option --daily=\[number\]
 
 These features are currently not related, you can use any combination of them. When an end date is defined the application will simply remind you on every run of how many days are left.
 
 If one of this options is used, a file called 'dbs_work.yml' is created in the working directory. This file is used to store the goals and the tracking information. If you want to get rid of all tracking, simply delete this file. To disable a specific kind of tracking, just call the options mentioned above with no arguments. That would delete the defined value. An example:
 
-  docbook_status --end=2099-01-01 --total=1000000  endofworld.xml
+  `docbook_status --end=2099-01-01 --total=1000000  endofworld.xml`
 
 This call would define the goals: scheduled delivery date of 2099-01-01, and a total document size of one million words. To disable the time tracking call it again with no argument:
 
-  docbook_status --end endofworld.xml
+  `docbook_status --end endofworld.xml`
 
 This would delete the defined delivery date but not the total. Once defined the goal options must not be repeated, since they are stored in the 'dbs_work.yml' file.
 
 
-== Integration, Customization
+## Integration, Customization
 
 In the unlikely case that you don't like the standard screen output and would prefer to replace it, there are other output formats available, JSON and YAML, which make that possible. Normally all output is formatted for output on a terminal screen, but the option _--outputformat_ alllows to specify a different output format, that is printed to STDOUT. Using that you could create your own frontend or integrate the application with other tools (like editors).
 
 Use
 
-   docbook_status --outputformat=yaml
+   `docbook_status --outputformat=yaml`
 or
-   docbook_status --outputformat=json
+   `docbook_status --outputformat=json`
 
 to get YAML or JSON structures back. The structure returned is equivalent to the normal terminal output:
 
- * file - path to XML file
- * modified - the modification time of the XML file
+* file - path to XML file
+* modified - the modification time of the XML file
 
- * sections - an array of section entries, each with
+* sections - an array of section entries, each with
   * title - section name
   * words - word count
   * level - section level in the document hierarchy
   * tag - the section's DocBook tag
 
- * remarks - (optional) an array of remark entries, each with
+* remarks - (optional) an array of remark entries, each with
   * keyword - uppercase keyword, e.g. REMARK, FIXME
   * text - remark text
   * file - file name, location of the remark
   * line - line number, location of the remark
 
- * goals - (optional) information about the defined writing goals
+* goals - (optional) information about the defined writing goals
   * start - start date of the tracking
   * end - scheduled end date or nil
   * goal_total - planned total word count or 0
   * goal_daily - planned daily word count or 0
 
- * today - (optional) document size information
+* today - (optional) document size information
   * min - minimum no. of words
   * max - maximum no. of words
   * start - first word count
   * end - last (current) word count
   * ctr - number of runs
 
-== Download
+## Download
 
 https://rubygems.org/gems/docbook_status
 
-== Requirements
+## Requirements
 
 * libxml2
 * json (optional, install the gem if you want JSON output for Ruby 1.8)
 * win32console (optional, install the gem if you want color support on MS Windows)
 
-== Install
+## Install
 
 * gem install docbook_status
 
-== Homepage
+## Homepage
 
-http://rvolz.github.com/docbook_status/
+https://github.com/rvolz/docbook_status/
 
-== License
+## License
 
 The MIT License
 
-Copyright (c) 2011-12 Rainer Volz
+Copyright (c) 2011-19 Rainer Volz
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/docbook_status

@@ -9,8 +9,8 @@
 require 'rubygems'
 require 'optparse'
 require 'yaml'
-require 'zucker/env'
-# For Windows and/or Ruby 1.8
+require 'os'
+# For Windows
 begin
   require 'json'
   @json_available = true
@@ -58,9 +58,9 @@ NOVAL = -1
 @end_date = NOVAL
 
 banner = <<EOB
-docbook_status, Version #{DocbookStatus.version}
+docbook_status, Version #{DocbookStatus::VERSION}
 
-Display DocBook 5 document structure and word counts.
+Show DocBook5 document structure and word counts.
 
 Usage: docbook_status [options] <DOCBOOK-FILE>
 EOB
@@ -75,25 +75,25 @@ opts.on('--remarks[=FILTER]', String, 'Show the remarks, comments. Use a keyword
   end
 }
 opts.on('--end[=DATE]', String, 'Goal: planned delivery date, YYYY-MM-DD') {|val|
-  if val.nil?
-    @end_date = nil
+  @end_date = if val.nil?
+    nil
   else
-    @end_date = Date.parse(val)
-  end
+    Date.parse(val)
+              end
 }
-opts.on('--total[=WORDS]',Integer, 'Goal: total number of words') {|val|
-  if val.nil?
-    @total_words = 0
+opts.on('--total[=WORDS]', Integer, 'Goal: total number of words') {|val|
+  @total_words = if val.nil?
+    0
   else
-    @total_words = val.abs
-  end}
-opts.on('--daily[=WORDS]',Integer, 'Goal: daily number of words') {|val|
-  if val.nil?
-    @daily_words = 0
+    val.abs
+                 end}
+opts.on('--daily[=WORDS]', Integer, 'Goal: daily number of words') {|val|
+  @daily_words = if val.nil?
+    0
   else
-    @daily_words = val.abs
-  end}
-opts.on('--outputformat=yaml|json',['json','yaml'],'Return the result in YAML or JSON format') {|format|
+    val.abs
+                 end}
+opts.on('--outputformat=yaml|json', ['json', 'yaml'], 'Return the result in YAML or JSON format') {|format|
   case
   when format == 'yaml'
     @output_format = :yaml
@@ -125,20 +125,19 @@ end
 # * magenta if >70 and < 100%
 # * green if >= 100%
 #
-def meter(actual,goal)
+def meter(actual, goal)
   ad = actual.to_f / goal.to_f
-  percs = ""
-  case
-  when ad <= 0.3
-    fct = lambda {|s| s.red.bold}
-  when ad > 0.3 && ad <= 0.7
-    fct = lambda {|s| s.red}
-  when ad > 0.7 && ad < 1.0
-    fct = lambda {|s| s.magenta}
-  else
-    fct = lambda {|s| s.green}
-  end
-  [actual.to_s,"%3.0f\%" % (ad*100)].map {|s| fct.call(s)}
+  fct = case
+          when ad <= 0.3
+            ->(s) { s.red.bold}
+          when ad > 0.3 && ad <= 0.7
+            ->(s) { s.red}
+          when ad > 0.7 && ad < 1.0
+            ->(s) { s.magenta}
+          else
+            ->(s) { s.green}
+        end
+  [actual.to_s, format("%3.0f\%%", (ad*100))].map {|s| fct.call(s)}
 end
 
 # Format the output for the screen and print it
@@ -157,12 +156,12 @@ def output_terminal(doc_info)
     gwdaily = doc_info[:goals][:goal_daily]
     unless gwtotal == 0
       tactual = doc_info[:sections][0][:words]
-      (tactuals,tactperc) = meter(tactual,gwtotal)
+      (tactuals, tactperc) = meter(tactual, gwtotal)
     end
     unless gwdaily == 0
       # Coloring the actuals
       dactual = doc_info[:today][:end] - doc_info[:today][:start]
-      (dactuals,dactperc) = meter(dactual,gwdaily)
+      (dactuals, dactperc) = meter(dactual, gwdaily)
     end
     unless gdend.nil?
       dstart = doc_info[:goals][:start]
@@ -184,20 +183,20 @@ def output_terminal(doc_info)
   # Structure
   puts
   puts "Document structure".bold
-  puts "%-57.57s %-16s %5s" % ['Title','Tag','Words']
+  puts format("%-57.57s %-16s %5s", 'Title', 'Tag', 'Words')
   puts "-"*80
   doc_info[:sections].each do |s|
-    puts "%-57.57s %-16s %5d" % [(' ' * s[:level])+s[:title], s[:tag], s[:words]]
+    puts format("%-57.57s %-16s %5d", (' ' * s[:level])+s[:title], s[:tag], s[:words])
   end
   #Remarks
   if doc_info[:remarks]
     puts
     puts "Remarks".bold
-    puts "%-10.10s %20.20s %5s %-52s" % %w[Type File Line Content]
+    puts format("%-10.10s %20.20s %5s %-52s", Type, File, Line, Content)
     puts "-"*80
     doc_info[:remarks].each do |r|
-      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
+      puts format("%-10.10s %20.20s %5d %-42.42s", "#{r[:keyword]}", r[:file], r[:line], r[:text])
+      puts format("%s %-42.42s", ' '*37, r[:text][42..84]) if r[:text].length > 42
     end
   end
 end
@@ -227,14 +226,14 @@ def run(file)
     dbs_h.planned_end(@end_date) if @end_date != NOVAL
     dbs_h.total_words(@total_words) if @total_words != NOVAL
     dbs_h.daily_words(@daily_words) if @daily_words != NOVAL
-    dbs_h.add(DateTime.now,doc_info[:sections][0][:words])
+    dbs_h.add(DateTime.now, doc_info[:sections][0][:words])
     dbs_h.save
     doc_info[:goals] = dbs_h.goals
     doc_info[:today] = dbs_h.today
   end
   case
   when @output_format == :yaml
-    YAML.dump(doc_info,STDOUT)
+    YAML.dump(doc_info, STDOUT)
   when @output_format == :json
     STDOUT.puts doc_info.to_json
   else
@@ -254,7 +253,7 @@ unless File.exists?(rest[0])
 end
 
 # The main routine
-puts("docbook_status, Version #{DocbookStatus.version}") if @output_format == :screen
+puts("docbook_status, Version #{DocbookStatus::VERSION}") if @output_format == :screen
 run(rest[0])
 exit 0
 

data/lib/docbook_status.rb

@@ -9,7 +9,7 @@ module DocbookStatus
   # Returns the version string for the library.
   #
   def self.version
-    @version ||= File.read(path('version.txt')).strip
+    @version ||= DocbookStatus::VERSION
   end
 
   # Returns the library path for the module. If any arguments are given,

data/lib/docbook_status/history.rb

@@ -1,8 +1,9 @@
- # -*- encoding:utf-8 -*-
+# frozen_string_literal: true
 
 require 'yaml'
-module DocbookStatus
+require 'date'
 
+module DocbookStatus
   # Manages the history of writing progress in two modes. In session
   # or demon mode the history shows progress for the user session. In
   # normal mode the history is only maintained for calendar days,
@@ -32,64 +33,64 @@ module DocbookStatus
   # * ctr (number of entries for the day)
   #
   class History
-
     # History file, YAML format
     HISTORY_FILE = 'dbs_work.yml'
 
     # Does the history file exist?
-    def self.exists?()
-      File.exists?(HISTORY_FILE)
+    def self.exists?
+      File.exist?(HISTORY_FILE)
     end
 
     # Load the exisiting writing history
-    def initialize(name,end_planned=nil,goal_total=0,goal_daily=0)
-      if File.exists?(HISTORY_FILE)
-        @history = YAML.load_file(HISTORY_FILE)
-      else
-        @history = {:file => name,
-          :goal => {
-            :start => Date.today,
-            :end => end_planned,
-            :goal_total => goal_total,
-            :goal_daily => goal_daily},
-          :current => [],
-          :archive => {}}
-      end
+    def initialize(name, end_planned = nil, goal_total = 0, goal_daily = 0)
+      @history = if File.exist?(HISTORY_FILE)
+                   YAML.load_file(HISTORY_FILE)
+                 else
+                   { file: name,
+                     goal: {
+                       start: Date.today,
+                       end: end_planned,
+                       goal_total: goal_total,
+                       goal_daily: goal_daily
+                     },
+                     current: [],
+                     archive: {} }
+                 end
     end
 
     def planned_end(date)
-      @history[:goal][:end]=date
+      @history[:goal][:end] = date
     end
 
     def total_words(tw)
-      @history[:goal][:goal_total]=tw
+      @history[:goal][:goal_total] = tw
     end
 
     def daily_words(tw)
-      @history[:goal][:goal_daily]=tw
+      @history[:goal][:goal_daily] = tw
     end
 
     # Add to the history
-    def add(ts,word_count)
+    def add(ts, word_count)
       # 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?)
+      if @history[:archive][k].nil?
+        @history[:archive][k] = { min: word_count, max: word_count, start: word_count, end: word_count, ctr: 1 }
+      else
         @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
         @history[:archive][k][:end] = word_count
         @history[:archive][k][:ctr] += 1
-      else
-        @history[:archive][k] = {:min => word_count, :max => word_count, :start => word_count, :end => word_count, :ctr => 1}
       end
     end
 
     # Is there already a history?
     def history?
-      @history[:archive].length != 0
+      !@history[:archive].empty?
     end
 
     # Convenience - returns the statistics for today
@@ -104,7 +105,7 @@ module DocbookStatus
 
     # Save the writing history
     def save
-      File.open(HISTORY_FILE, 'w') {|f| YAML.dump(@history,f)}
+      File.open(HISTORY_FILE, 'w') { |f| YAML.dump(@history, f) }
     end
   end
 end

data/lib/docbook_status/version.rb

@@ -0,0 +1,3 @@
+module DocbookStatus
+  VERSION = "1.1.0"
+end

metadata

@@ -1,141 +1,152 @@
 --- !ruby/object:Gem::Specification
 name: docbook_status
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Rainer Volz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2019-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: zucker
+  name: os
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: bones
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: '1.16'
   type: :development
   prerelease: false
   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.
-email: dev@textmulch.de
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- dev@textmulch.de
 executables:
 - docbook_status
 extensions: []
-extra_rdoc_files:
-- History.txt
-- README.rdoc
-- bin/docbook_status
+extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- Gemfile.lock
-- History.txt
-- README.rdoc
-- Rakefile
+- CHANGELOG.md
+- LICENSE.md
+- README.md
 - 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/fixtures/book-remarks.xml
-- 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
+- lib/docbook_status/version.rb
 homepage: http://projekte.textmulch.de/docbook_status/
-licenses: []
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
-rdoc_options:
-- --main
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: docbook_status
-rubygems_version: 1.8.24
+rubyforge_project: 
+rubygems_version: 2.7.3
 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
+specification_version: 4
+summary: DocBook utility showing document structure and word count
+test_files: []

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,22 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    bones (3.8.0)
-      little-plugger (~> 1.1.3)
-      loquacious (~> 1.9.1)
-      rake (>= 0.8.7)
-    libxml-ruby (2.2.2)
-    little-plugger (1.1.3)
-    loquacious (1.9.1)
-    rake (10.0.3)
-    term-ansicolor (1.0.7)
-    zucker (12.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bones
-  libxml-ruby (~> 2.2.2)
-  term-ansicolor
-  zucker

data/History.txt

@@ -1,50 +0,0 @@
-== 1.0.1 / 2012-12-23
-
-* Updated documentation url
-
-== 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.
-* Improved the platform compatibility. Should now work better on Windows.
-* Color support is now optional on Windows. Is switched on if gem 'win32console' is available.
-* JSON support is now optional. Is switched on if the json library (1.9) or gem (1.8) is available.
-
-== 0.4.0 / 2011-10-04
-
-* 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
-* Added YAML and JSON output formats, available with option --outputformat
-* Minor fixes
-** Removed daemon state persistence file dw_state.yml
-** Colorized screen output
-** Reorganized library
-
-== 0.2.1 / 2011-09-18
-
-* Minor fixes for Gem packaging
-
-== 0.2.0 / 2011-09-18
-
-* Added remarks listing.
-* Minor fixes
-** removed _formalpara_ from the list of countable text elements because they contain _para_ elements
-
-== 0.1.1 / 2011-09-07
-
-* Documentation corrections
-
-== 0.1.0 / 2011-09-07
-
-* Initial version

data/Rakefile

@@ -1,21 +0,0 @@
-#-*- encoding: utf-8 ; mode:ruby -*-
-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.textmulch.de/docbook_status/'
-  ignore_file  '.gitignore'
-  exclude       << 'dbs-about.org'
-  depend_on     'libxml-ruby'
-  depend_on     'term-ansicolor'
-  depend_on     'zucker'
-}

data/spec/docbook_status_spec.rb

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

data/spec/spec_helper.rb

@@ -1,15 +0,0 @@
-
-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-remarks.xml

@@ -1,29 +0,0 @@
-<?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/fixtures/book.xml

@@ -1,27 +0,0 @@
-<?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>
-    <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

@@ -1,15 +0,0 @@
-<?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

@@ -1,8 +0,0 @@
-  <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.
-       <remark>FIXME Ausbauen.</remark>
-    </para>
-  </chapter>

data/test/fixtures/chapter2xi.xml

@@ -1,11 +0,0 @@
-<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

@@ -1,8 +0,0 @@
-  <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

@@ -1,9 +0,0 @@
-<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

@@ -1,134 +0,0 @@
-# -*- 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::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::Status.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::Status.new()
-    ind = XML::Document.string(input)
-    sections = dbs.analyze_document(ind)
-    sections.must_equal([{:title => 'A1', :words => 17, :level => 0, :tag => 'article'},
-                         {: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')
-    if (dbs.has_xinclude?(ind))
-      ind.xinclude
-    end
-    sections = dbs.analyze_document(ind)
-    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')
-  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.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/test/test_history.rb

@@ -1,74 +0,0 @@
-# -*- 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 +0,0 @@
-1.0.1