ulink-checker 0.0.1 → 0.0.3

data/bin/ulink-checker

@@ -27,7 +27,7 @@ def processCommandLine
   options = {}
 
   optparse = OptionParser.new do |opts|
-    opts.banner = "ulink-checker v0.0.1"
+    opts.banner = "ulink-checker v0.0.3"
 
     #options[:followXIInclude] = false
     #opts.on( '-x', '--xiinclude', 'Follow' ) do
@@ -35,7 +35,7 @@ def processCommandLine
     #end
 
     options[:url] = ""
-    opts.on( '-u URL', '--url URL', 'check XML at URL (not implemented yet)' ) do | url |
+    opts.on( '-u URL', '--url URL', 'check XML at URL' ) do | url |
       options[:url] = url
     end
     
@@ -66,16 +66,8 @@ def processCommandLine
     exit
   end
 
-  # if they specify URL then too bad!
-  if (options[:url] != "") then
-    puts "SORRY: URLs are not supported yet"
-    puts
-    puts optparse
-    exit
-  end
-
   #can't specify both url and file, only one
-  if (options[:url] != "" and option[:file] != "") then
+  if (options[:url] != "" and options[:file] != "") then
     puts "ERROR: can only specify one of file or URL."
     puts
     puts optparse
@@ -93,12 +85,23 @@ if (options[:file] != "") then
    puts "Checking URLs in #{options[:file]} ...\n\n"
 
    File.open(options[:file]) do |fp|
+      #TODO: deal with xiinclude fails here
       doc = Nokogiri::XML(fp) do |conf|
          conf.strict.dtdload.noent.nocdata.xinclude
       end
    end
 end
 
+if (options[:url] != "") then
+   puts "Checking URLs from #{options[:url]} ...\n\n"   
+   #TODO: deal with SSL
+   #TODO: deal with xiinclude fails here
+   doc = Nokogiri::XML(open(options[:url])) do | conf |
+      conf.strict.dtdload.noent.nocdata.xinclude
+   end
+end
+
+
 # xpath the urls out
 urls = doc.xpath("//ulink")
 

data/readme.md

@@ -8,15 +8,26 @@ Reports:
    * REDIRECT: when the URL gets redirected
    * OK: if the URL works fine
 
-## setup
+## install
 
-1. `$ bundle update`
+Requires Ruby and RubyGems. 
+
+  * on Fedora: `$ sudo yum install ruby-devel rubygems`
+
+1. `$ sudo gem install ulink-checker`
 
 ## run
 
-1. `./ulink-checker.rb somedocbook.xml`
+1. `ulink-checker -f somedocbook.xml` or `ulink-checker -u http://server.com/project/en-US/somedocbook.xml`
 2. See the amazing technicolour output
 
-## why isn't it a gem
+![](ulink-0.0.2-ss.png)
+
+## problems
 
-Because I haven't done it yet.
+1. -f doesn't check for file's existence (crash)
+2. -u doesn't handling URL or network errors (crash)
+1. non-XML content crashes it
+2. failed `<xi:include>`s will crash it without a helpful message
+3. can't disable `<xi:include>` support 
+4. -u doesn't work with https

data/ulink-checker.gemspec

@@ -1,7 +1,8 @@
 Gem::Specification.new do |s|
   s.name        = 'ulink-checker'
-  s.version     = '0.0.1'
+  s.version     = '0.0.3'
   s.date        = '2013-03-12'
+  s.homepage    = 'https://github.com/dmison/ulink-checker'
   s.summary     = "checks urls in docbook ulink tags"
   s.description = "checks urls in docbook ulink tags"
   s.authors     = ["darrin Mison"]
@@ -14,6 +15,10 @@ Gem::Specification.new do |s|
     "bin/ulink-checker", 
     "lib/duration.rb", 
     "lib/link_checker_override.rb"]
-  s.homepage    =
-    'https://github.com/dmison/ulink-checker'
-end
+
+  s.add_runtime_dependency("nokogiri",  [">= 1.5.6"])
+  s.add_runtime_dependency("rainbow", [">= 1.1.4"])
+  s.add_runtime_dependency("link-checker", [">= 0.7.2"])
+  
+end
+

metadata

@@ -1,67 +1,99 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ulink-checker
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - darrin Mison
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-12 00:00:00 +10:00
-default_executable: 
-dependencies: []
-
+date: 2013-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: link-checker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 description: checks urls in docbook ulink tags
 email: dmison@me.com
-executables: 
+executables:
 - ulink-checker
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Gemfile
 - readme.md
 - ulink-checker.gemspec
 - bin/ulink-checker
 - lib/duration.rb
 - lib/link_checker_override.rb
-has_rdoc: true
 homepage: https://github.com/dmison/ulink-checker
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: checks urls in docbook ulink tags
 test_files: []
-