docbook_status 0.4.0 → 0.5.0

data/Gemfile

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

data/Gemfile.lock

@@ -5,20 +5,18 @@ GEM
       little-plugger (>= 1.1.2)
       loquacious (>= 1.8.1)
       rake (>= 0.8.7)
-    directory_watcher (1.4.1)
-    json (1.6.1)
     libxml-ruby (2.2.2)
     little-plugger (1.1.2)
     loquacious (1.8.1)
     rake (0.9.2)
     term-ansicolor (1.0.6)
+    zucker (11)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bones
-  directory_watcher
-  json
   libxml-ruby (~> 2.2.2)
   term-ansicolor
+  zucker

data/History.txt

@@ -1,4 +1,11 @@
-== 0.4.0 / 2011-10-??
+== 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

data/README.rdoc

@@ -15,7 +15,7 @@ A utility for DocBook authors/publishers showing the document structure (section
 
 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 once, manually:
+To run docbook_status:
 
    docbook_status myproject.xml
 
@@ -37,12 +37,6 @@ If you need to preprocess the XML before feeding it to docbook_status, there is
 
 --pre takes shell commands as arguments and executes them before starting the analysis on the XML file.
 
-Finally, if you are tired to run docbook_status manually each time you changed your file, you could run the application in demon mode, continually:
-
-   docbook_status --demon --glob "*.xml" --dir "." myproject.xml
-
-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 terminated by simply pressing RETURN.
-
 == Tracking writing progress
 
 As an experiment docbook_status provides features to define and track writing goals/schedules. Currently there are the following options:
@@ -111,6 +105,8 @@ https://rubygems.org/gems/docbook_status
 == 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
 

data/Rakefile

@@ -13,8 +13,9 @@ Bones {
   authors  'Rainer Volz'
   email    'dev@textmulch.de'
   url      'http://rvolz.github.com/docbook_status/'
-  depend_on     'directory_watcher'
+  ignore_file  '.gitignore'
+  exclude       << 'dbs-about.org'
   depend_on     'libxml-ruby'
-  depend_on     'json'
   depend_on     'term-ansicolor'
+  depend_on     'zucker'
 }

data/bin/docbook_status

@@ -3,21 +3,43 @@
 ##
 # 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.
+# 5 documents.
 #
 
 require 'rubygems'
-require "bundler/setup"
 require 'optparse'
-require 'directory_watcher'
 require 'yaml'
-require 'json'
-require 'term/ansicolor'
+require 'zucker/env'
+# For Windows and/or Ruby 1.8
+begin
+  require 'json'
+  @json_available = true
+rescue LoadError
+  @json_available = false
+end
 
-class String
-  include Term::ANSIColor
+# Windows (RubyInstaller) needs the additional gem.
+# If not present create dummies for the color routines.
+if OS.windows?
+  begin
+    require 'win32console'
+    require 'term/ansicolor'
+    class String
+      include Term::ANSIColor
+    end
+  rescue LoadError
+    class String
+      def red; self; end
+      def green; self; end
+      def magenta; self; end
+      def bold; self; end
+    end
+  end
+else
+  require 'term/ansicolor'
+  class String
+    include Term::ANSIColor
+  end
 end
 
 require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib docbook_status]))
@@ -45,10 +67,7 @@ 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 = File.expand_path(val)}
-opts.on('--pre COMMAND', String, 'A shell command that should be executed before') {|val| @pre << val}
+opts.on('--pre COMMAND', String, 'A shell command that should be executed first') {|val| @pre << val}
 opts.on('--remarks[=FILTER]', String, 'Show the remarks, comments. Use a keyword FILTER to restrict the listing') {|val|
   @remarks = true
   unless (val.nil? || val.empty?)
@@ -74,12 +93,18 @@ opts.on('--daily[=WORDS]',Integer, 'Goal: daily number of words') {|val|
   else
     @daily_words = val.abs
   end}
-opts.on('--outputformat=yaml|json',['json','yaml'],'Return the result in YAML or JSON format instead of printing it') {|format|
+opts.on('--outputformat=yaml|json',['json','yaml'],'Return the result in YAML or JSON format') {|format|
   case
   when format == 'yaml'
     @output_format = :yaml
   when format == 'json'
-    @output_format = :json
+    if @json_available
+      @output_format = :json
+    else
+      @output_format = :screen
+      STDERR.puts "JSON support not available. Please install the json gem first."
+      exit 1
+    end
   else
     STDERR.puts "Unknown output format #{format}. Using screen output."
     @output = :screen
@@ -217,28 +242,6 @@ def run(file)
   end
 end
 
-
-# Demon routine for continuous processing of a DocBook document.
-# This routine calls _run_ whenever the filesystem signals changes. To
-# reduce load it waits for a defined time (interval * stable) before
-# starting the actual processing.
-#
-def demon(file)
-  dw = DirectoryWatcher.new @dir, :glob => @glob, :pre_load => true
-  dw.interval = 5.0
-  dw.stable = 2
-  dw.add_observer {|*args|
-    args.each {|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
@@ -253,7 +256,5 @@ end
 # The main routine
 puts("docbook_status, Version #{DocbookStatus.version}") if @output_format == :screen
 run(rest[0])
-if (@demon)
-  demon(rest[0])
-end
 exit 0
+

data/version.txt

@@ -1 +1 @@
-0.4.0
+0.5.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_status
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-04 00:00:00.000000000Z
+date: 2011-10-15 00:00:00.000000000Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: directory_watcher
-  requirement: &2165156720 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *2165156720
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2165156200 !ruby/object:Gem::Requirement
+  requirement: &2167250780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,32 +21,32 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *2165156200
+  version_requirements: *2167250780
 - !ruby/object:Gem::Dependency
-  name: json
-  requirement: &2165155600 !ruby/object:Gem::Requirement
+  name: term-ansicolor
+  requirement: &2167250280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2165155600
+  version_requirements: *2167250280
 - !ruby/object:Gem::Dependency
-  name: term-ansicolor
-  requirement: &2165154960 !ruby/object:Gem::Requirement
+  name: zucker
+  requirement: &2167249780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: '11'
   type: :runtime
   prerelease: false
-  version_requirements: *2165154960
+  version_requirements: *2167249780
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2165154300 !ruby/object:Gem::Requirement
+  requirement: &2167249140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +54,7 @@ dependencies:
         version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *2165154300
+  version_requirements: *2167249140
 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.
@@ -78,7 +67,6 @@ extra_rdoc_files:
 - README.rdoc
 - bin/docbook_status
 files:
-- .bnsignore
 - Gemfile
 - Gemfile.lock
 - History.txt
@@ -122,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: docbook_status
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A utility for DocBook authors/publishers showing the document structure (sections)

data/.bnsignore

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