docbook_files 0.2.0 → 0.3.0

data/About.org

@@ -0,0 +1,77 @@
+#+title: Notizen
+#+description: Notizen und Aufgaben für docbook_files
+
+* Eigenschaften
+
+** Grafische Ausgabe der Dateistruktur
+
+*** Graphviz?
+Für Ruby gibt es das viele Module, siehe zum Beispiel graph.
+
+  graph version 2.3.0 has been released!
+
+  * <https://github.com/seattlerb/graph>
+
+  Graph is a type of hash that outputs in graphviz's dot format. It
+  comes with a command-line interface that is easily pluggable.
+
+  It ships with plugins to graph dependencies and status of installed
+  rubygems, rake tasks, homebrew ports, mac ports, and freebsd ports,
+  coloring leaf nodes blue, outdated nodes red, and outdated leaf nodes
+  purple (red+blue).
+
+
+** Detailausgabe gegenüber Hierarchie
+
+Die Hierarchie ist die Hauptausgabe. Allerdings kann man sich über
+'--details' auch die Detailangaben zu allen beteiligten Dateien
+ausgeben lassen. Hier werden alle Angaben ausgegeben, die oben
+optional sind.
+
+Besonders wichtig ist die Zusammenfassung, also Dateien, die an
+mehreren Stellen eingebunden werden, also mehrere Eltern haben!
+
+Die Detailausgabe führt dann über zum Releasedokument.
+
+** Releasedokument
+
+Die Ausgabe kann in einer Datei gespeichert werden, die dann als
+Manifest für ein Archiv dienen kann. Anhand des Dokuments kann man
+schauen, ob die vorliegenden Dateien dem gespeicherten Stand
+entsprechen.
+
+** Ausgabeformate
+*** Graphviz & HTML
+*** TODO YAML, JSON
+*** DocBook
+*** RDF?
+
+** Zusammenhang mit SCM
+
+Wie bei Bones?
+
+** DONE Änderung Anzeige
+*** Hierarchie
+
+Nur der Hierarchiebaum, aber mit längeren Namen. Das heißt, die
+Dateien werden mit Pfad angezeigt, mit relativem zum Masterdokument.
+
+Falls zu lang am Anfang kürzen mit Ellipse.
+
+URIs oder nicht relative Dateien werden mit dem Anfang angezeigt,
+ggf. in der Mitte gekürzt.
+
+*** Zusammenfassung
+
+ * X Dateien
+ * Y inkludierte DocBooks
+ * Z referenzierte
+
+YAML/JSON übernehmen und seinen eigenen machen.
+*** Details
+
+Die restlichen Angaben werden in die optionalen Details
+verschoben. Die Optionen sind dann nicht mehr notwendig.
+
+Wenn jemand den Bericht nicht mag, kann er gern die Daten über
+

data/Gemfile

@@ -5,5 +5,11 @@ gem "term-ansicolor"
 gem "wand"
 
 group :development do
-	gem "bones"
+  gem "bones"
+  gem 'turn'
+  gem 'rspec'
+  gem 'guard'
+  gem 'rb-fsevent'
+  gem 'growl_notify'
+  gem 'guard-rspec'
 end

data/Gemfile.lock

@@ -1,17 +1,38 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    ansi (1.3.0)
     bones (3.7.1)
       little-plugger (>= 1.1.2)
       loquacious (>= 1.8.1)
       rake (>= 0.8.7)
+    diff-lcs (1.1.3)
+    growl_notify (0.0.3)
+      rb-appscript
+    guard (0.8.4)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.0)
+      guard (>= 0.8.4)
     libxml-ruby (2.2.2)
     little-plugger (1.1.2)
     loquacious (1.9.0)
     mime-types (1.16)
     rake (0.9.2)
+    rb-appscript (0.6.1)
+    rb-fsevent (0.4.3.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
     safe_shell (1.0.1)
     term-ansicolor (1.0.6)
+    thor (0.14.6)
+    turn (0.8.3)
+      ansi
     wand (0.4)
       mime-types
       safe_shell (~> 1.0.0)
@@ -21,6 +42,12 @@ PLATFORMS
 
 DEPENDENCIES
   bones
+  growl_notify
+  guard
+  guard-rspec
   libxml-ruby
+  rb-fsevent
+  rspec
   term-ansicolor
+  turn
   wand

data/Guardfile

@@ -0,0 +1,6 @@
+# -*- encoding:utf-8; mode:ruby -*-
+guard 'rspec', :version => 2, :cli => '--color --format nested' do
+  watch(%r{^spec/(.+)_spec\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.0 / 2011-10-11
+
+* Reorganized output
+* Added --details option and output
+* Reorganize library
+* Move to RSpec for testing
+
 == 0.2.0 / 2011-10-10
 
 * Added search for referenced files (e.g. media files included via a 'fileref' attribute)

data/README.md

@@ -8,21 +8,21 @@ Features
 
 * lists and checks included files (XInclude)
 * lists and checks referenced files (media files and others, specidifed by _fileref_)
+* shows errors, e.g. not existing files
+* provides a detail listing
 
 Synopsis
 --------
 
-docbook_files is a command line application, bin/docbook_files, which checks the files that are included or referenced in a DocBook 5 project. (Note: In version 0.1.0 we are only checking included files, but that will change.)
+docbook_files is a command line application, bin/docbook_files, which checks the files that are included or referenced in a DocBook 5 project. 
 
-  docbook_files myproject.xml
+   docbook_files myproject.xml
 
-This will result in a indentet list of the file names, starting from file _myproject.xml_ and following every XInclude link or _fileref_ reference. _fileref_ attributes are used in _mediaobject_ tags to specify external image, video, and audio files. Files that could not be found are shown in red.
+This will result in a overview listing of the file names, starting from file _myproject.xml_ and following every XInclude link or _fileref_ reference. _fileref_ attributes are used in _mediaobject_ tags to specify external image, video, and audio files. Files that could not be found are shown in red.
 
-Using options the output can be enhanced with more file information, use the classical _docbook_files --help_ to see all available options. They range from file size to MIME types and XML namespaces. Example:
+   docbook_files --details myproject.xml
 
-  docbook_files --ts --namespace myproject.xml
-
-would result in a list with the added information of the last modified timestamp and the XML namespace of each XML file.
+The --details option adds, well yes, details to the overview: Size, type information, timestamp and checksum.
 
 Requirements
 ------------

data/Rakefile

@@ -1,12 +1,15 @@
-#-*- encoding: utf-8 ; mode:ruby -*-
+#-*- mode:ruby -*-
 begin
   require 'bones'
 rescue LoadError
   abort '### Please install the "bones" gem ###'
 end
 
-task :default => 'test:run'
-task 'gem:release' => 'test:run'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => 'spec'
+task 'gem:release' => 'spec'
 
 Bones {
   name         'docbook_files'
@@ -14,7 +17,6 @@ Bones {
   email        'dev@textmulch.de'
   url          'http://github.com/rvolz/docbook_files/'
   ignore_file  '.gitignore'
-  ignore_file  'About.org'
   depend_on    'libxml-ruby'
   depend_on    'term-ansicolor'
   depend_on    'wand'

data/bin/docbook_files

@@ -4,95 +4,13 @@
 #
 
 require 'rubygems'
-#require "bundler/setup"
-require 'optparse'
-#require 'yaml'
-#require 'json'
-require 'term/ansicolor'
-
-class String
-  include Term::ANSIColor
-end
-
-
-require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib docbook_files]))
-
-banner = <<EOB
-docbook_files, Version #{DocbookFiles::VERSION}
-
-Displays the include hierarchy of a DocBook 5 project. 
-Use the options to see additional information about each file. 
-Files that could not be found are shown in red.
-
-Usage: docbook_files [options] <DOCBOOK-FILE>
-EOB
-
-@output_format = :screen
-
-props = []
-opts = OptionParser.new
-ivs = DocbookFiles::FileData.init_vars
-ivs.each do |k,v|
-  opts.on("--#{k.to_s}","#{v}") {|val| props << k}
-end
-opts.banner = banner
-rest = opts.parse(ARGV)
-
-# Print banner if called without arguments
-if rest.length < 1
-  puts opts.to_s 
-  exit 1
-end
-
-unless File.exists?(rest[0])
-  STDERR.puts "Error: File #{rest[0]} not found."
-  exit 1
+begin
+  require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib docbook_files]))
+rescue LoadError
+  require 'docbook_files'
 end
 
-# The main routine
-puts("docbook_status, Version #{DocbookFiles::VERSION}") if @output_format == :screen
-dbf = DocbookFiles::Docbook.new(rest[0])
-table = dbf.list_as_table([:name,:exists]+props)
-puts
-puts 'File Hierarchy'
-puts '-'*80
-
-output_string = "%s %s" + props.map{|p| " %s"}.join
-
-def emptyval?(val)
-  if val.nil?
-    true
-  else
-    if (val.class == String)
-      val.empty?
-    else
-      false
-    end
-  end
-end
+DocbookFiles.run
 
-  table.each_with_index do |t,index|
-    vals = ['-'*t[:level]+'>',t[:name]] + props.map {|p| 
-      if (emptyval?(t[p]))
-        '<>'
-      else
-        t[p]
-      end
-    }
-    output = output_string % vals
-    if (index == 0)
-      output = "+" + output
-    elsif (index == table.length-1)
-      output = "+" + output
-    else
-      output = "|" + output
-    end
-    if t[:exists] == false
-      puts output.red
-    else
-      puts output
-    end
-  end
+#EOF
 
-puts
-exit 0

data/lib/docbook_files/app.rb

@@ -0,0 +1,212 @@
+# -*-encoding:utf-8-*-
+
+require 'optparse'
+require 'yaml'
+require 'json'
+require 'term/ansicolor'
+
+class String
+  include Term::ANSIColor
+end
+  
+module DocbookFiles
+  
+  # Create a new instance of App, and run the +docbook_files+ application given
+  # the command line _args_.
+  #
+  def self.run( args = nil )
+    args ||= ARGV.dup.map! { |v| v.dup }
+    ::DocbookFiles::App.new.run args
+  end
+  
+  class App
+    @@banner = <<EOB
+docbook_files, Version #{DocbookFiles::VERSION}
+
+Displays the include hierarchy of a DocBook 5 project. 
+Use the options to see additional information about each file. 
+Files that could not be found are shown in red.
+
+Usage: docbook_files [options] <DOCBOOK-FILE>
+EOB
+
+    def initialize(opts = {})
+      opts[:stdout] ||= $stdout
+      opts[:stderr] ||= $stderr
+      @opts = opts
+      @stdout = opts[:stdout]
+      @stderr = opts[:stderr]
+      @opts[:output_format] ||= :screen
+      @opts[:details] ||= false
+      @props = [:name, :full_name, :namespace, :docbook,
+                :version, :tag, :parent, :exists, :ts, :size, :checksum, :mime]
+    end
+
+    def run(args)
+      opts = OptionParser.new
+      opts.on('--details','List file details') {|val| @opts[:details] = true}
+      # opts.on('--outputformat=yaml|json',['json','yaml'],
+      #         'Return the result in YAML or JSON format instead of printing it') {|format|
+      #   case
+      #   when format == 'yaml'
+      #     @opts[:output_format] = :yaml
+      #   when format == 'json'
+      #     @opts[:output_format] = :json
+      #   else
+      #     STDERR.puts "Unknown output format #{format}. Using screen output.".orange
+      #   end
+      # }  
+      
+      opts.banner = @@banner
+      rest = opts.parse(args)
+
+      # Print banner if called without arguments
+      if rest.length < 1
+        @stdout.puts opts.to_s 
+        exit 1
+      end
+
+      # The main routine
+      @stdout.puts("docbook_files, Version #{DocbookFiles::VERSION}") if @opts[:output_format] == :screen
+      unless File.exists?(rest[0])
+        @stderr.puts "Error: File #{rest[0]} not found.".red
+        exit 1
+      end
+
+      begin
+        dbf = DocbookFiles::Docbook.new(rest[0])
+        table = dbf.list_as_table(@props)
+      rescue => exc
+        @stderr.puts exc.inspect.red
+      end
+      output(table)
+    end
+
+    # Terminal output to @stdout
+    def output(table)
+      output_string = "%3d %-60s %4s %10s" 
+      @stdout.puts
+      @stdout.puts 'File Hierarchy'.bold
+      @stdout.puts "%3s %-60s %4s %10s" % ['Lvl', 'File','Type','Size']
+      @stdout.puts '-'*80
+      sum_size = 0
+      sum_not_existing = 0
+      table.each do |t|
+        output = output_string % [t[:level],
+                                  format_name(t[:level],t[:full_name],table[0][:full_name]),
+                                  t[:type].to_s,
+                                  format_size(t[:size])]
+        sum_size += t[:size]
+        if t[:exists] == false
+          @stdout.puts output.red
+          sum_not_existing += 1
+        else
+          @stdout.puts output
+        end
+      end
+      @stdout.puts '-'*80
+      summary = "#{table.length} file(s) with approx. #{format_size(sum_size)}."
+      if sum_not_existing > 0
+        summary += " #{sum_not_existing} file(s) not found.".red
+      end
+      @stdout.puts summary
+      if @opts[:details]
+        @stdout.puts
+        @stdout.puts "Details".bold
+        table.each do |t|
+          fname = format_name(0,t[:full_name],table[0][:full_name])
+          @stdout.puts "File: %s" % [(t[:exists] ? fname : fname.red)]
+          if (t[:type] == FileData::TYPE_MAIN)
+            @stdout.puts "Main file"
+          elsif (t[:type] == FileData::TYPE_INCLUDE)
+            @stdout.puts "Included by: %s" % [t[:parent]]
+          else
+            @stdout.puts "Referenced by: %s" % [t[:parent]]
+          end
+          next unless t[:exists]
+          @stdout.puts "Size: %s (%d)" % [format_size(t[:size]),t[:size]]
+          if t[:docbook]
+            @stdout.puts "Type: DocBook, Version #{t[:version]}, Tag: #{t[:tag]}"
+          else
+            @stdout.puts "MIME: #{val_s(t[:mime])}"
+          end
+          @stdout.puts "Timestamp: %s" % [t[:ts]]
+          @stdout.puts "Checksum: %s" % [t[:checksum]]          
+          @stdout.puts
+        end
+      end
+    end
+
+
+    # Format the filename to indicate the level in the hierarchy.
+    # Indentation = two spaces per level.
+    #
+    # If the file is located somewhere below the main file, only the
+    # relative part of the path is shown, else the full path.
+    # If the resulting string is too long for display it is shortened.
+    #
+    def format_name(level, full_name, main_name)
+      main_dir = File.dirname(main_name)
+      md = full_name.match("^#{main_dir}/")
+      if md.nil?
+        nname = full_name
+      else
+        nname = md.post_match
+      end
+      lnname = '  '*level+nname
+      if (lnname.length > 60)
+        lnname[0..3]+'...'+lnname[-54,lnname.length-1]
+      else
+        lnname
+      end
+    end
+
+    # :stopdoc:
+    KB = 1024
+    MB = 1048576
+    GB = 1073741824
+    TB = 1099511627776
+    PB = 1125899906842624
+    # :startdoc:
+    
+    # Format a file size for human consumption.
+    # Sizes >= 1PB will return 'XXL'
+    def format_size(sz)
+      if (emptyval?(sz))
+        '-'
+      else
+        case
+        when sz < KB then  "#{sz}B"
+        when sz >= KB && sz < MB then "#{sz/KB}KB"
+        when sz >= MB && sz < GB then "#{sz/MB}MB"
+        when sz >= GB && sz < TB then "#{sz/GB}GB"
+        when sz >= TB && sz < PB then "#{sz/TB}TB"
+        else
+          "XXL"
+        end
+      end
+    end
+
+    # Return a string for the value, '<>' if there is none.
+    def val_s(val)
+      if emptyval?(val)
+        '-'
+      else
+        val.to_s
+      end
+    end
+
+    # Check whether the value is nil or empty.
+    def emptyval?(val)
+      if val.nil?
+        true
+      else
+        if (val.class == String)
+          val.empty?
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/docbook_files/docbook.rb

@@ -23,7 +23,7 @@ module DocbookFiles
 
     # Return the FileData tree representing the include
     # hierarchy.
-    #
+    #    
     def list
       @fd_tree ||= analyze_file(@main_name,File.dirname(@main_name))
       @fd_tree
@@ -128,5 +128,6 @@ private
       fl.includes = files.map {|f| analyze_file(f,parent_dir,fl)}
       fl
     end
+
   end
 end

data/lib/docbook_files/file_data.rb

@@ -7,13 +7,13 @@ module DocbookFiles
   # Data about a member file of a DocBook project
   class FileData
 
-    # file name, full file path, existence flag, last modified timestamp, size in bytes
-    # SHA1 checksum, MIME type, array of included FileDatas
-    #attr_accessor :name, :full_name, :exists, :ts, :size, :checksum, :mime, :includes
-
-    # XML namespace, Flag for DocBook NS, DocBook version, start tag
-    #attr_accessor :namespace, :docbook, :version, :tag
-
+    # Type for the main/master file
+    TYPE_MAIN = :main
+    # Type for referenced files
+    TYPE_REFERENCE = :ref
+    # Type for included files
+    TYPE_INCLUDE = :inc
+    
     attr_accessor :name, :exists, :includes, :refs
 
     def FileData.init_vars()
@@ -79,36 +79,30 @@ module DocbookFiles
       self.traverse([:name])
     end
 
-    # Return a hash with the values for the passed symbols. 
-    # If the property list is empty all instance variables 
-    # are used, except the include.
+    # Return a hash with the values for the passed symbols.
+    # The type is added.
     # 
     # Example: to_hash([:name, :mime]) would return 
     #  {:name => "name", :mime => "application/xml"}.
     #
-    def to_hash(props=[])
-      me_hash = {}
-      if (props.empty?)
-        ivs = self.instance_variables
-        ivs.delete(:@includes)
-        props = ivs.map {|iv| ivs = iv.to_s; ivs[1,ivs.length].to_sym}
-      end
+    def to_hash(props,type)
+      me_hash = {:type => type}
       props.each {|p| me_hash[p] = self.send(p)}
       me_hash
     end
 
     # Return a tree-like array of maps with the 
     # requested properties (symbols)
-    def traverse(props=[])
-      me = self.to_hash(props)
+    def traverse(props=[],type=TYPE_MAIN)
+      me = self.to_hash(props,type)
       me2 = [me]
       unless @refs.empty?()
-        me2 += @refs.map {|r| r.to_hash(props)}
+        me2 += @refs.map {|r| r.to_hash(props,TYPE_REFERENCE)}
       end
       if @includes.empty?()
         me2
       else
-        me2 + @includes.map {|i| i.traverse(props)}
+        me2 + @includes.map {|i| i.traverse(props,TYPE_INCLUDE)}
       end
     end
 
@@ -116,15 +110,15 @@ module DocbookFiles
     # requested properties (symbols). Each entry gets a level 
     # indicator (:level) to show the tree-level.
     #
-    def traverse_as_table(props=[],level=0)
-      me = self.to_hash(props)
+    def traverse_as_table(props,level=0,type=TYPE_MAIN)
+      me = self.to_hash(props,type)
       me[:level] = level
       me2 = [me]
       unless @refs.empty?()
-        me2 += @refs.map {|r| x = r.to_hash(props); x[:level] = level+1; x}
+        me2 += @refs.map {|r| x = r.to_hash(props,TYPE_REFERENCE); x[:level] = level+1; x}
       end
       unless @includes.empty?()
-        me2 += @includes.map {|i| i.traverse_as_table(props,level+1)}
+        me2 += @includes.map {|i| i.traverse_as_table(props,level+1,TYPE_INCLUDE)}
       end
       me2.flatten
     end

data/spec/docbook_files/app_spec.rb

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+require_relative '../spec_helper'
+
+module DocbookFiles
+  describe App do
+
+    describe "displays file names" do
+      it "according to level" do
+        a = App.new
+        main_n = '/dir1/dir2/dir3/book.xml'
+        main_d = '/dir1/dir2/dir3/'
+        a.format_name(0,main_n,main_n).should == 'book.xml'
+        a.format_name(2,main_d+'chapter.xml',main_n).should == '    chapter.xml'
+        a.format_name(3,main_d+'dir4/chapter.xml',main_n).should == '      dir4/chapter.xml'
+      end
+
+      it "in full when not below main file" do
+        a = App.new
+        main_n = '/dir1/dir2/dir3/book.xml'
+        main_d = '/dir1/dir2/dir3/'
+        a.format_name(2,'/dir1/dir2/chapter4.xml',main_n).should == '    /dir1/dir2/chapter4.xml'
+      end
+
+      it "shortened when too long" do
+        a = App.new
+        main_d = '/dir1/dir2'*5
+        main_d2 = '/dir0/dir1/dir2'*5
+        main_n = main_d+'/book.xml'
+        a.format_name(2,main_d+'/chapter.xml',main_n).should == '    chapter.xml'
+        expected = "    ...r0/dir1/dir2/dir0/dir1/dir2/dir0/dir1/dir2/chapter.xml"
+        a.format_name(2,main_d2+'/chapter.xml',main_n).should == expected
+        a.format_name(2,main_d2+'/chapter.xml',main_n).length.should == 61
+      end
+
+    end
+    
+    it "formats file sizes for humans" do
+      a = App.new
+      a.format_size(1023).should == "1023B"
+      a.format_size(1024).should == "1KB"
+      a.format_size(1025).should == "1KB"
+      a.format_size(999*App::KB).should == "999KB"
+      a.format_size(1024*App::KB).should == "1MB"
+      a.format_size(3200*App::KB).should == "3MB"
+      a.format_size(9999*App::MB).should == "9GB"
+      a.format_size(1023*App::GB).should == "1023GB"
+      a.format_size(1024 + App::TB).should == "1TB"
+      a.format_size(1024 + App::PB).should == "XXL"
+    end
+  end
+end

data/spec/docbook_files/docbook_spec.rb

@@ -0,0 +1,72 @@
+# -*- encoding: utf-8 -*-
+require_relative '../spec_helper'
+
+module DocbookFiles
+  describe Docbook do
+    
+    it "can cope with invalid xml files" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/no-xml.xml")
+      actual = dbf.list()
+      actual.class.should == DocbookFiles::FileData
+      actual.name.should == "no-xml.xml"
+      actual.size.should == 15
+      actual.docbook.should be_false
+    end
+    
+    it "finds namespace, DocBookness, version" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/bookxi.xml")
+      actual = dbf.list()
+      actual.namespace.should == "http://docbook.org/ns/docbook"
+      actual.docbook.should be_true
+      actual.version.should == "5.0"
+    end
+    
+    it "finds no namespace, DocBookness, version" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/no-ns.xml")
+      actual = dbf.list()
+      actual.namespace.should be_empty
+      actual.docbook.should be_false 
+      actual.version.should be_empty
+    end			
+    
+    it "finds a tag" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/bookxi.xml")
+      actual = dbf.list()
+      actual.tag.should == "book"
+    end			
+    
+    it "lists" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/bookxi.xml")
+      actual = dbf.list()
+      expected = [{:type => :main, :name=>"bookxi.xml"}, 
+                  [{:type => :inc, :name=>"chapter2xi.xml"}, [{:type => :inc, :name=>"section1xi.xml"}]], 
+                  [{:type => :inc, :name=>"chapter3xi.xml"}], [{:type => :inc, :name=>"chapter4xi.xml"}]]
+      actual.names.should == expected
+    end
+    
+    it "lists as a table" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/bookxi.xml")
+      actual = dbf.list_as_table([:name])
+      expected = [{:type => :main, :name=>"bookxi.xml", :level=>0}, 
+                  {:type => :inc, :name=>"chapter2xi.xml", :level=>1}, 
+                  {:type => :inc, :name=>"section1xi.xml", :level=>2}, 
+                  {:type => :inc, :name=>"chapter3xi.xml", :level=>1}, 
+                  {:type => :inc, :name=>"chapter4xi.xml", :level=>1}]
+      actual.should == expected			
+    end
+    
+    it "finds referenced files" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/refs/book-simple.xml")
+      actual = dbf.list()
+      actual.refs.map{|r|r.name}.should == ["orange.png","orange.jpeg"]
+    end
+    
+    it "marks non-existing references" do
+      dbf = DocbookFiles::Docbook.new("spec/fixtures/refs/book-simple-err.xml")
+      actual = dbf.list()
+      actual.refs.map{|r|r.name}.should == ["orange.png","orange.jpeg"]
+      actual.refs.map{|r|r.exists}.should == [true,false]
+    end
+    
+  end
+end

data/spec/docbook_files/file_data_spec.rb

@@ -0,0 +1,78 @@
+# -*- encoding: utf-8 -*-
+require_relative '../spec_helper'
+require 'time'
+
+module  DocbookFiles 
+  describe FileData do
+    
+    it "calculates a checksum" do
+      f = FileData.new("spec/fixtures/bookxi.xml")
+      f.checksum.should == "7d240e7a084c16665ac59e5b927acd6a06953897"
+    end
+    
+    it "finds a XML MIME type" do
+      f = FileData.new("spec/fixtures/bookxi.xml")
+      f.mime.should == "application/xml"
+    end
+    
+    it "finds a plain text MIME type" do
+      pending("different MIME lib?") do
+        f = FileData.new("spec/fixtures/no-xml.xml")
+        f.mime.should_not == "application/xml"
+      end
+    end
+    
+    it "converts a single FileData instance to a hash" do
+      f = FileData.new("spec/fixtures/bookxi.xml")
+      actual = f.to_hash([:name,:mime,:size],FileData::TYPE_MAIN)
+      actual.should == {:type => :main, :name=>"bookxi.xml", :mime=>"application/xml", :size=>481}
+      actual = f.to_hash([:name, :full_name, :namespace, :docbook, :version, :tag, :parent, :exists, :ts, :size, :checksum, :mime],FileData::TYPE_MAIN)
+      expected = {:type => :main, :name=>"bookxi.xml", 
+        :full_name=>File.expand_path(".")+"/spec/fixtures/bookxi.xml", 
+        :namespace=>"", :docbook=>false, :version=>"", :tag=>"", :parent=>nil, :exists=>true, 
+        :ts=>Time.parse("2011-10-06 20:45:01 +0200"), :size=>481, 
+        :checksum=>"7d240e7a084c16665ac59e5b927acd6a06953897", :mime=>"application/xml"}
+      actual.should == expected			
+    end
+
+    it "converts a FileData tree to an array of hashes" do
+      f1 = FileData.new("spec/fixtures/bookxi.xml")
+      f2 = FileData.new("spec/fixtures/chapter2xi.xml")
+      f3 = FileData.new("spec/fixtures/chapter3xi.xml")
+      f1.includes = [f2]
+      f2.includes = [f3]
+      expected = [{:type => :main, :name=>"bookxi.xml", :mime=>"application/xml", :size=>481}, 
+                  [{:type => :inc, :name=>"chapter2xi.xml", :mime=>"application/xml", :size=>366}, 
+                   [{:type => :inc, :name=>"chapter3xi.xml", :mime=>"application/xml", :size=>286}]]]
+      actual = f1.traverse([:name,:mime,:size],FileData::TYPE_MAIN)
+      actual.should == expected
+    end
+    
+    it "converts a FileData tree to a table of hashes" do
+      f1 = FileData.new("spec/fixtures/bookxi.xml")
+      f2 = FileData.new("spec/fixtures/chapter2xi.xml")
+      f3 = FileData.new("spec/fixtures/chapter3xi.xml")
+      f1.includes = [f2]
+      f2.includes = [f3]
+      expected = [{:type => :main, :name=>"bookxi.xml", :mime=>"application/xml", :size=>481, :level=>0}, 
+                  {:type => :inc, :name=>"chapter2xi.xml", :mime=>"application/xml", :size=>366, :level=>1}, 
+                  {:type => :inc, :name=>"chapter3xi.xml", :mime=>"application/xml", :size=>286, :level=>2}]
+      actual = f1.traverse_as_table([:name,:mime,:size])
+      actual.should == expected
+    end
+
+    it "finds non-existing files" do
+      f1 = FileData.new("spec/fixtures/bookxi.xml")
+      f2 = FileData.new("spec/fixtures/chapter2xi.xml",".",f1)
+      f3 = FileData.new("spec/fixtures/chapter3xi.xml",".",f2)
+      f5 = FileData.new("spec/fixtures/non-existing.xml",".",f2)
+      f1.includes = [f2]
+      f2.includes = [f3,f5]
+      expected = [{:type => :inc, :name=>"non-existing.xml", :parent=>"chapter2xi.xml"}]
+      actual = f1.find_non_existing_files()
+      actual.should  == expected
+    end
+
+  end
+end
+

data/{test → spec}/fixtures/refs/chapter2xi.xml

@@ -20,6 +20,9 @@
     <imageobject>
       <imagedata align="right" width="6cm" format="JPEG" fileref="img/orange.jpeg"/>
     </imageobject> 
+      <imageobject>
+        <imagedata align="right" width="6cm" format="SVG" fileref="img/ship.svg"/>
+      </imageobject> 
     <textobject>
       <para>
         Textobject inside a mediaboject.

data/spec/fixtures/refs/img/ship.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="21 19 416 350" width="416pt" height="350pt"><metadata xmlns:dc="http://purl.org/dc/elements/1.1/"><dc:date>2011-10-11 18:52Z</dc:date><!-- Produced by OmniGraffle Professional 5.3.2 --></metadata><defs><filter id="Shadow" filterUnits="userSpaceOnUse"><feGaussianBlur in="SourceAlpha" result="blur" stdDeviation="3.488"/><feOffset in="blur" result="offset" dx="0" dy="4"/><feFlood flood-color="black" flood-opacity=".75" result="flood"/><feComposite in="flood" in2="offset" operator="in"/></filter></defs><g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"><title>Arbeitsfläche 1</title><g><title>Ebene 1</title><g><use xl:href="#id1_Graphic" filter="url(#Shadow)"/></g><g id="id1_Graphic"><rect x="32.96875" y="26" width="392.7461" height="327.3711" fill="white"/><rect x="32.96875" y="26" width="392.7461" height="327.3711" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/></g></g></g></svg>

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
+# -*- encoding: utf-8 -*-
 
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib docbook_files]))
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   # == Mock Framework
   #
   # RSpec uses it's own mocking framework by default. If you prefer to

data/version.txt

@@ -1 +1 @@
-0.2.0
+0.3.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_files
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-10 00:00:00.000000000Z
+date: 2011-10-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2160079640 !ruby/object:Gem::Requirement
+  requirement: &2167031960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *2160079640
+  version_requirements: *2167031960
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &2160076200 !ruby/object:Gem::Requirement
+  requirement: &2167031020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *2160076200
+  version_requirements: *2167031020
 - !ruby/object:Gem::Dependency
   name: wand
-  requirement: &2160074160 !ruby/object:Gem::Requirement
+  requirement: &2167030100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2160074160
+  version_requirements: *2167030100
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2152251960 !ruby/object:Gem::Requirement
+  requirement: &2167029100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *2152251960
+  version_requirements: *2167029100
 description: docbook_files lists and checks all files related to a DocBook writing
   project.
 email: dev@textmulch.de
@@ -65,40 +65,43 @@ extra_rdoc_files:
 - History.txt
 - bin/docbook_files
 files:
-- .DS_Store
-- .gitignore
+- About.org
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - History.txt
 - README.md
 - Rakefile
 - bin/docbook_files
 - lib/docbook_files.rb
+- lib/docbook_files/app.rb
 - lib/docbook_files/docbook.rb
 - lib/docbook_files/file_data.rb
+- spec/docbook_files/app_spec.rb
+- spec/docbook_files/docbook_spec.rb
+- spec/docbook_files/file_data_spec.rb
 - spec/docbook_files_spec.rb
+- spec/fixtures/.DS_Store
+- spec/fixtures/book-nonexisting.xml
+- spec/fixtures/bookxi.xml
+- spec/fixtures/c4/chapter4xi.xml
+- spec/fixtures/chapter2xi.xml
+- spec/fixtures/chapter3xi.xml
+- spec/fixtures/no-ns.xml
+- spec/fixtures/no-xml.xml
+- spec/fixtures/refs/.DS_Store
+- spec/fixtures/refs/book-simple-err.xml
+- spec/fixtures/refs/book-simple.xml
+- spec/fixtures/refs/bookxi.xml
+- spec/fixtures/refs/c4/chapter4xi.xml
+- spec/fixtures/refs/chapter2xi.xml
+- spec/fixtures/refs/chapter3xi.xml
+- spec/fixtures/refs/img/orange.jpeg
+- spec/fixtures/refs/img/orange.png
+- spec/fixtures/refs/img/ship.svg
+- spec/fixtures/refs/section1xi.xml
+- spec/fixtures/section1xi.xml
 - spec/spec_helper.rb
-- test/.DS_Store
-- test/docbook_files/test_docbook.rb
-- test/docbook_files/test_file_data.rb
-- test/fixtures/book-nonexisting.xml
-- test/fixtures/bookxi.xml
-- test/fixtures/c4/chapter4xi.xml
-- test/fixtures/chapter2xi.xml
-- test/fixtures/chapter3xi.xml
-- test/fixtures/no-ns.xml
-- test/fixtures/no-xml.xml
-- test/fixtures/refs/book-simple-err.xml
-- test/fixtures/refs/book-simple.xml
-- test/fixtures/refs/bookxi.xml
-- test/fixtures/refs/c4/chapter4xi.xml
-- test/fixtures/refs/chapter2xi.xml
-- test/fixtures/refs/chapter3xi.xml
-- test/fixtures/refs/img/orange.jpeg
-- test/fixtures/refs/img/orange.png
-- test/fixtures/refs/section1xi.xml
-- test/fixtures/section1xi.xml
-- test/test_docbook_files.rb
 - version.txt
 homepage: http://github.com/rvolz/docbook_files/
 licenses: []
@@ -122,11 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: docbook_files
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: docbook_files lists and checks all files related to a DocBook writing project.
-test_files:
-- test/docbook_files/test_docbook.rb
-- test/docbook_files/test_file_data.rb
-- test/test_docbook_files.rb
+test_files: []

data/.gitignore

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

data/test/docbook_files/test_docbook.rb

@@ -1,76 +0,0 @@
-# -*- encoding: utf-8 -*-
-require 'minitest/spec'
-require 'turn'
-require "docbook_files"
-
-MiniTest::Unit.use_natural_language_case_names = true
-
-module  DocbookFiles 
-	describe Docbook do
-
-		it "can cope with invalid xml files" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/no-xml.xml")
-			actual = dbf.list()
-			actual.must_be_kind_of(DocbookFiles::FileData)
-			actual.name.must_equal("no-xml.xml")
-			actual.size.must_equal(15)
-			actual.docbook.must_equal(false)
-		end
-					
-		it "finds namespace, DocBookness, version" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/bookxi.xml")
-			actual = dbf.list()
-			actual.namespace.must_equal("http://docbook.org/ns/docbook")
-			actual.docbook.must_equal(true)
-			actual.version.must_equal("5.0")
-		end
-
-		it "finds no namespace, DocBookness, version" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/no-ns.xml")
-			actual = dbf.list()
-			actual.namespace.must_equal("")
-			actual.docbook.must_equal(false)
-			actual.version.must_equal("")
-		end			
-
-		it "finds a tag" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/bookxi.xml")
-			actual = dbf.list()
-			actual.tag.must_equal("book")
-		end			
-
-		it "lists" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/bookxi.xml")
-			actual = dbf.list()
-			expected = [{:name=>"bookxi.xml"}, 
-				[{:name=>"chapter2xi.xml"}, [{:name=>"section1xi.xml"}]], 
-				[{:name=>"chapter3xi.xml"}], [{:name=>"chapter4xi.xml"}]]
-			actual.names.must_equal(expected)			
-		end
-
-		it "lists as a table" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/bookxi.xml")
-			actual = dbf.list_as_table([:name])
-			expected = [{:name=>"bookxi.xml", :level=>0}, 
-				{:name=>"chapter2xi.xml", :level=>1}, 
-				{:name=>"section1xi.xml", :level=>2}, 
-				{:name=>"chapter3xi.xml", :level=>1}, 
-				{:name=>"chapter4xi.xml", :level=>1}]
-			actual.must_equal(expected)			
-		end
-
-		it "finds referenced files" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/refs/book-simple.xml")
-			actual = dbf.list()
-			actual.refs.map{|r|r.name}.must_equal(["orange.png","orange.jpeg"])
-		end
-
-		it "marks non-existing references" do
-			dbf = DocbookFiles::Docbook.new("test/fixtures/refs/book-simple-err.xml")
-			actual = dbf.list()
-			actual.refs.map{|r|r.name}.must_equal(["orange.png","orange.jpeg"])
-			actual.refs.map{|r|r.exists}.must_equal([true,false])
-		end
-
-	end
-end

data/test/docbook_files/test_file_data.rb

@@ -1,83 +0,0 @@
-# -*- encoding: utf-8 -*-
-require 'minitest/spec'
-require 'turn'
-require "docbook_files"
-require 'date'
-
-MiniTest::Unit.use_natural_language_case_names = true
-
-module  DocbookFiles 
-	describe FileData do
-		it "initializes" do
-		end
-		
-		it "calculates a checksum" do
-			f = FileData.new("test/fixtures/bookxi.xml")
-			f.checksum.must_equal("7d240e7a084c16665ac59e5b927acd6a06953897") 
-		end
-
-		it "finds a XML MIME type" do
-			f = FileData.new("test/fixtures/bookxi.xml")
-			f.mime.must_equal("application/xml")
-		end
-
-		it "finds a plain text MIME type" do
-			skip "Different MIME lib?"
-			f = FileData.new("test/fixtures/no-xml.xml")
-			f.mime.wont_equal("application/xml")
-		end
-
-		it "converts a single FileData instance to a hash" do
-			f = FileData.new("test/fixtures/bookxi.xml")
-			actual = f.to_hash([:name,:mime,:size])
-			actual.must_equal({:name=>"bookxi.xml", :mime=>"application/xml", :size=>481})
-			actual = f.to_hash()
-			expected = {:name=>"bookxi.xml", 
-				:full_name=>"/Users/rv/Documents/Projekte/docbook_files/test/fixtures/bookxi.xml", 
-				:namespace=>"", :docbook=>false, :version=>"", :tag=>"", :parent=>nil, :exists=>true, 
-				:ts=>Time.parse("2011-10-06 20:45:01 +0200"), :size=>481, 
-				:checksum=>"7d240e7a084c16665ac59e5b927acd6a06953897", :mime=>"application/xml", :refs => []}
-			actual.must_equal(expected)			
-		end
-
-		it "converts a FileData tree to an array of hashes" do
-			f1 = FileData.new("test/fixtures/bookxi.xml")
-			f2 = FileData.new("test/fixtures/chapter2xi.xml")
-			f3 = FileData.new("test/fixtures/chapter3xi.xml")
-			f1.includes = [f2]
-			f2.includes = [f3]
-			expected = [{:name=>"bookxi.xml", :mime=>"application/xml", :size=>481}, 
-				[{:name=>"chapter2xi.xml", :mime=>"application/xml", :size=>366}, 
-					[{:name=>"chapter3xi.xml", :mime=>"application/xml", :size=>286}]]]
-			actual = f1.traverse([:name,:mime,:size])
-			actual.must_equal(expected)
-		end
-
-		it "converts a FileData tree to a table of hashes" do
-			f1 = FileData.new("test/fixtures/bookxi.xml")
-			f2 = FileData.new("test/fixtures/chapter2xi.xml")
-			f3 = FileData.new("test/fixtures/chapter3xi.xml")
-			f1.includes = [f2]
-			f2.includes = [f3]
-			expected = [{:name=>"bookxi.xml", :mime=>"application/xml", :size=>481, :level=>0}, 
-				{:name=>"chapter2xi.xml", :mime=>"application/xml", :size=>366, :level=>1}, 
-				{:name=>"chapter3xi.xml", :mime=>"application/xml", :size=>286, :level=>2}]
-			actual = f1.traverse_as_table([:name,:mime,:size])
-			actual.must_equal(expected)
-		end
-
-		it "finds non-existing files" do
-			f1 = FileData.new("test/fixtures/bookxi.xml")
-			f2 = FileData.new("test/fixtures/chapter2xi.xml",".",f1)
-			f3 = FileData.new("test/fixtures/chapter3xi.xml",".",f2)
-			f5 = FileData.new("test/fixtures/non-existing.xml",".",f2)
-			f1.includes = [f2]
-			f2.includes = [f3,f5]
-			expected = [{:name=>"non-existing.xml", :parent=>"chapter2xi.xml"}]
-			actual = f1.find_non_existing_files()
-			actual.must_equal(expected)
-		end
-
-	end
-end
-

data/test/test_docbook_files.rb

@@ -1,6 +0,0 @@
-# -*- encoding: utf-8 -*-
-require 'minitest/spec'
-require 'minitest/autorun'
-require "docbook_files"
-require 'turn'
-