docbook_files 0.4.0 → 0.5.0

data/spec/docbook_files/docbook_spec.rb

@@ -7,7 +7,7 @@ module DocbookFiles
     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.class.should == DocbookFiles::FileRef
       actual.name.should == "no-xml.xml"
       actual.size.should == 15
       actual.docbook.should be_false

data/spec/docbook_files/file_data_spec.rb

@@ -5,74 +5,84 @@ require 'time'
 module  DocbookFiles 
   describe FileData do
     
+    before(:each) do
+      FileData.reset()
+    end
+ 
     it "calculates a checksum" do
-      f = FileData.new("spec/fixtures/bookxi.xml")
+      f = FileData.for("spec/fixtures/bookxi.xml")
       f.checksum.should == "7d240e7a084c16665ac59e5b927acd6a06953897"
     end
     
     it "finds a XML MIME type" do
-      f = FileData.new("spec/fixtures/bookxi.xml")
+      f = FileData.for("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 = FileData.for("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, :status, :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, :status=>FileData::STATUS_OK, 
-        :ts=>File.mtime(File.expand_path(".")+"/spec/fixtures/bookxi.xml"), :size=>481, 
-        :checksum=>"7d240e7a084c16665ac59e5b927acd6a06953897", :mime=>"application/xml"}
-      actual.should == expected			
+
+    it "constructs file names (path) relative to the main file" do
+      f1 = FileData.for("spec/fixtures/bookxi.xml")
+      f2 = FileData.for("spec/fixtures/chapter2xi.xml")
+      f3 = FileData.for("spec/fixtures/c4/chapter4xi.xml")
+      f1.add_includes([f2,f3])
+      f1.name.should == "bookxi.xml"
+      f1.path.should == "bookxi.xml"
+      f1.full_name.should == File.expand_path(".")+"/spec/fixtures/bookxi.xml"
+      f3.name.should == "chapter4xi.xml"
+      f3.path.should == "c4/chapter4xi.xml"
+      f3.full_name.should == File.expand_path(".")+"/spec/fixtures/c4/chapter4xi.xml"
     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
+    it "doesn't change absolute file names in path construction" do
+      f1 = FileData.for("spec/fixtures/bookxi.xml")
+      f2 = FileData.for("/spec/fixtures/chapter2xi.xml")
+      f2.name.should == "chapter2xi.xml"
+      f2.path.should == "/spec/fixtures/chapter2xi.xml"
+      f2.full_name.should == "/spec/fixtures/chapter2xi.xml"
     end
+
+    it "doesn't change file names outside the main dir in path construction" do
+      f1 = FileData.for("spec/fixtures/bookxi.xml")
+      f2 = FileData.for("../spec2/fixtures/chapter2xi.xml")
+      f2.name.should == "chapter2xi.xml"
+      f2.path.should == File.expand_path("..")+"/spec2/fixtures/chapter2xi.xml"
+      f2.full_name.should == File.expand_path("..")+"/spec2/fixtures/chapter2xi.xml"
+    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
+    it "stores only one instance per file" do
+      f1 = FileData.for("spec/fixtures/bookxi.xml")
+      f2 = FileData.for("spec/fixtures/bookxi.xml")
+      FileData.files.size.should == 1
     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
+    
+    it "stores includes" do
+      f1 = FileData.for("spec/fixtures/bookxi.xml")
+      f2 = FileData.for("spec/fixtures/chapter2xi.xml")
+      f3 = FileData.for("spec/fixtures/chapter3xi.xml")
+      f1.add_includes([f2,f3])
+      f1s = FileData::storage[f1.key]
+      f1s.includes.should == [f2, f3]
+      f2s = FileData::storage[f2.key]
+      f2s.included_by.should == [f1]
     end
-
+    
+    it "stores references" do
+      f1 = FileData.for("spec/fixtures/bookxi.xml")
+      f2 = FileData.for("spec/fixtures/chapter2xi.xml")
+      f3 = FileData.for("spec/fixtures/chapter3xi.xml")
+      f1.add_references([f2,f3])
+      f1s = FileData::storage[f1.key]
+      f1s.references.should == [f2, f3]
+      f2s = FileData::storage[f2.key]
+      f2s.referenced_by.should == [f1]
+    end
+    
   end
 end
 

data/spec/docbook_files/file_ref_spec.rb

@@ -0,0 +1,97 @@
+# -*- encoding: utf-8 -*-
+require_relative '../spec_helper'
+require 'time'
+
+module  DocbookFiles 
+  describe FileRef do
+    
+    before(:each) do
+      FileData.reset()
+    end
+    
+    it "converts a single FileRef instance to a hash" do
+      f = FileRef.new("spec/fixtures/bookxi.xml")
+      actual = f.to_hash([:name,:mime,:size],FileRefTypes::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, :status, :ts, :size, :checksum, :mime],
+                         FileRefTypes::TYPE_MAIN)
+      expected = {:type => :main, :name=>"bookxi.xml", 
+        :full_name=>File.expand_path(".")+"/spec/fixtures/bookxi.xml", 
+        :namespace=>"", :docbook=>false,
+        :version=>"", :tag=>"", :parent=>nil, :status=>FileData::STATUS_OK, 
+        :ts=>File.mtime(File.expand_path(".")+"/spec/fixtures/bookxi.xml"), :size=>481, 
+        :checksum=>"7d240e7a084c16665ac59e5b927acd6a06953897", :mime=>"application/xml"}
+      actual.should == expected
+    end
+
+    it "converts a FileRef tree to an array of hashes" do
+      f1 = FileRef.new("spec/fixtures/bookxi.xml")
+      f2 = FileRef.new("spec/fixtures/chapter2xi.xml")
+      f3 = FileRef.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],FileRefTypes::TYPE_MAIN)
+      actual.should == expected
+    end
+    
+    it "converts a FileRef tree to a table of hashes" do
+      f1 = FileRef.new("spec/fixtures/bookxi.xml")
+      f2 = FileRef.new("spec/fixtures/chapter2xi.xml")
+      f3 = FileRef.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 = FileRef.new("spec/fixtures/bookxi.xml")
+      f2 = FileRef.new("spec/fixtures/chapter2xi.xml",".",f1)
+      f3 = FileRef.new("spec/fixtures/chapter3xi.xml",".",f2)
+      f5 = FileRef.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
+
+    it "collects includes of all FileRef instances" do
+      f1 = FileRef.new("spec/fixtures/bookxi.xml")
+      f2 = FileRef.new("spec/fixtures/chapter2xi.xml",".",f1)
+      f3 = FileRef.new("spec/fixtures/chapter3xi.xml",".",f2)
+      f5 = FileRef.new("spec/fixtures/non-existing.xml",".",f2)
+      f6 = FileRef.new("spec/fixtures/c4/chapter4xi.xml",".",f1)
+      f7 = FileRef.new("spec/fixtures/non-existing.xml",".",f7)
+      f1.includes = [f2,f6]
+      f2.includes = [f3,f5]
+      f6.includes = [f7]
+      store = FileData.storage
+      fr = store[f7.file_data.key]
+      fr.included_by.map{|ib|ib.key}.should == [f2.file_data.key, f6.file_data.key]
+    end
+    
+    it "collects references of all FileRef instances" do
+      f1 = FileRef.new("spec/fixtures/bookxi.xml")
+      f2 = FileRef.new("spec/fixtures/chapter2xi.xml",".",f1)
+      f3 = FileRef.new("spec/fixtures/pic1.jpg",".",f2)
+      f5 = FileRef.new("spec/fixtures/pic2.jpg",".",f2)
+      f6 = FileRef.new("spec/fixtures/c4/chapter4xi.xml",".",f1)
+      f7 = FileRef.new("spec/fixtures/pic2.jpg",".",f7)
+      f1.includes = [f2,f6]
+      f2.refs = [f3,f5]
+      f6.refs = [f7]
+      store = FileData.storage
+      fr = store[f7.file_data.key]
+      fr.referenced_by.map{|ib|ib.key}.should == [f2.file_data.key, f6.file_data.key]
+    end    
+  end
+end
+

data/version.txt

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_files
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-14 00:00:00.000000000Z
+date: 2011-10-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2167326260 !ruby/object:Gem::Requirement
+  requirement: &2167029400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *2167326260
+  version_requirements: *2167029400
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &2167325580 !ruby/object:Gem::Requirement
+  requirement: &2167028280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2167325580
+  version_requirements: *2167028280
 - !ruby/object:Gem::Dependency
   name: wand
-  requirement: &2167324900 !ruby/object:Gem::Requirement
+  requirement: &2167027500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,21 +43,32 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2167324900
+  version_requirements: *2167027500
 - !ruby/object:Gem::Dependency
-  name: json
-  requirement: &2167324260 !ruby/object:Gem::Requirement
+  name: zucker
+  requirement: &2167026460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '11'
   type: :runtime
   prerelease: false
-  version_requirements: *2167324260
+  version_requirements: *2167026460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2167025840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *2167025840
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2167323640 !ruby/object:Gem::Requirement
+  requirement: &2167025160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +76,7 @@ dependencies:
         version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *2167323640
+  version_requirements: *2167025160
 description: docbook_files lists and checks all files related to a DocBook writing
   project.
 email: dev@textmulch.de
@@ -80,6 +91,7 @@ files:
 - Gemfile.lock
 - Guardfile
 - History.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/docbook_files
@@ -87,9 +99,12 @@ files:
 - lib/docbook_files/app.rb
 - lib/docbook_files/docbook.rb
 - lib/docbook_files/file_data.rb
+- lib/docbook_files/file_ref.rb
+- lib/docbook_files/file_ref_types.rb
 - spec/docbook_files/app_spec.rb
 - spec/docbook_files/docbook_spec.rb
 - spec/docbook_files/file_data_spec.rb
+- spec/docbook_files/file_ref_spec.rb
 - spec/docbook_files_spec.rb
 - spec/fixtures/book-nonexisting.xml
 - spec/fixtures/bookxi.xml
@@ -112,8 +127,26 @@ files:
 - spec/spec_helper.rb
 - version.txt
 homepage: http://rvolz.github.com/docbook_files/
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+post_install_message: ! '
+
+  Please note:
+
+
+  - docbook_files uses color to mark problematic files.
+
+  On Windows, you should additionally install the gem ''win32console''
+
+  to enable color output in the terminal.
+
+
+  - JSON output is optional for Ruby 1.8. Please install the gem ''json''
+
+  if you are running Ruby 1.8 and want JSON output.
+
+
+'
 rdoc_options:
 - --main
 - README.md