epub_validator 0.1.1 → 0.2.0

data/README.md

@@ -1,6 +1,6 @@
 # epubValidator - Check your EPUB Books
 
-This library will check that your EPUB v2 files are valid IDPF documents (using epubcheck-1.2.jar) and return a successful or error message. It can be called as a Ruby library, or invoked from the command line.
+This library will check that your .epub files are valid IDPF EPUB v2.x documents and return a successful or error message. It can be called as a Ruby library, or invoked from the command line.
 
 For more about the IDPF see http://idpf.org
 
@@ -21,19 +21,21 @@ Sample usage and output:
 require 'epub_validator'
 
 ev = EpubValidator.check('/path/to/sample.epub')
-ev.message.each do |m|
+puts ev[:valid]
+ev[:message].each do |m|
   puts m
 end
-=> # FAILED!
-=> # ERROR: OPS/toc.ncx(21): 'OPS/': referenced resource exists, but not declared in the OPF file
+=> 0
+=> ERROR: OPS/toc.ncx(21): 'OPS/': referenced resource exists, but not declared in the OPF file
 ```
 
 Now from the command line:
 
 ``` terminal
-$ bin/epub_validator /path/to/sample.epub
-Checking....
-FAILED!
+$ epub_validator /path/to/sample.epub
+
+Checking....FAILED!
+
 ERROR: OPS/toc.ncx(21): 'OPS/': referenced resource exists, but not declared in the OPF file
 ```
 
@@ -44,6 +46,6 @@ Java must be installed and set in your PATH.
 
 ## Future Features
 
-* Accept a directory containing many .epub files for processing.
-* When using the command line, have option to write results to a log file
+* Command line: accept directory containing many .epub files for processing.
+* Command line: have switch for writing results to log file
 * Format "ERROR" and "WARNING" output for more intuitive instructions.

data/bin/epub_validator

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 require 'epub_validator'
 #require 'epub_validator/command'
 
-# Thanks heroku!
+# From heroku!
 args = ARGV.dup
 ARGV.clear
 command = args.shift.strip rescue 'help'
@@ -14,7 +14,12 @@ command = args.shift.strip rescue 'help'
 # need to implement Command class
 #EpubValidator::Command.run(command, args)
 
-puts "Checking...."
+print "\nChecking...."
 ev = EpubValidator.check(command)
-puts ev
+if (ev[:valid] == 1)
+  print "Passed.\n"
+else
+  print "FAILED!\n\n"
+  puts ev[:message]
+end
 

data/epub_validator.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "ZenTest"
-  s.add_development_dependency "autotest-growl"
+  s.add_development_dependency('rspec', '>= 2.8.0')
+  s.add_development_dependency('ZenTest', '>= 4.6.2')
+  s.add_development_dependency('autotest-growl', '>= 0.2.16')
 end

data/lib/epub_validator/format_message.rb

@@ -1,7 +1,9 @@
 module EpubValidator
   class FormatMessage
     def process_message(message)
-      return ['Passed.'] if message.match('No errors or warnings detected')
+      status = Hash.new
+      status[:valid] = 1
+      return status if message.match('No errors or warnings detected')
 
       m_array = message.split(/\n/)
 
@@ -12,7 +14,9 @@ module EpubValidator
           s.match('^Check finished.*')
       end
 
-      m_array.unshift('FAILED!')
+      status[:valid] = 0
+      status[:message] = m_array
+      return status
     end
   end
 end

data/lib/epub_validator/version.rb

@@ -1,3 +1,3 @@
 module EpubValidator
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/epub_validator/format_message_spec.rb

@@ -2,27 +2,33 @@ require 'spec_helper'
 
 module EpubValidator
   describe FormatMessage do
-    context "when it recieves a missing file message" do
-      it "should return a 'FAILED!' message as an array" do
+    context "when it receives a missing file message" do
+      it "should return a failed hash message" do
         message = "ERROR: test.epub: I/O error: test.epub (No such file or directory)"
-        formatted_message = ["FAILED!", "ERROR: test.epub: I/O error: test.epub (No such file or directory)"]
+        formatted_message = ["#{message}"]
+
         errm = FormatMessage.new
-        errm.process_message(message).should eq(formatted_message)
+        m = errm.process_message(message)
+        m[:valid].should eq(0)
+        m[:message].should eq(formatted_message)
       end
     end
-    context "when it recieves a valid file message" do
-      it "should return 'Passed.' message as an array" do
+    context "when it receives a valid file message" do
+      it "should return :valid => 1" do
         message = "Epubcheck Version 1.2\n\nNo errors or warnings detected\n"
         errm = FormatMessage.new
-        errm.process_message(message).should eq(['Passed.'])
+        errm.process_message(message).should eq(:valid => 1)
       end
     end
     context "when it recieves an invalid file message" do
       it "should return error message as an array" do
         message = "Epubcheck Version 1.2\n\nERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing\n\nCheck finished with warnings or errors!"
-        formatted_message = ["FAILED!", "ERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing"]
+        formatted_message = ["ERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing"]
+
         errm = FormatMessage.new
-        errm.process_message(message).should eq(formatted_message)
+        m = errm.process_message(message)
+        m[:valid].should eq(0)
+        m[:message].should eq(formatted_message)
       end
     end
   end

data/spec/epub_validator/process_epub_spec.rb

@@ -11,9 +11,12 @@ module EpubValidator
       end
       it "should return the output message formatted" do
         message = "Epubcheck Version 1.2\n\nERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing\n\nCheck finished with warnings or errors!"
-        formatted_message = ["FAILED!", "ERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing"]
+        formatted_message = ["ERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing"]
+
         ec = ProcessEpub.new
-        ec.format_epubcheck_output(message).should eq(formatted_message)
+        m = ec.format_epubcheck_output(message)
+        m[:valid].should eq(0)
+        m[:message].should eq(formatted_message)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epub_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,41 +9,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-20 00:00:00.000000000Z
+date: 2012-01-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11670320 !ruby/object:Gem::Requirement
+  requirement: &18848460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *11670320
+  version_requirements: *18848460
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &11669320 !ruby/object:Gem::Requirement
+  requirement: &18847980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.6.2
   type: :development
   prerelease: false
-  version_requirements: *11669320
+  version_requirements: *18847980
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &11668720 !ruby/object:Gem::Requirement
+  requirement: &18847500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.16
   type: :development
   prerelease: false
-  version_requirements: *11668720
+  version_requirements: *18847500
 description: EPUB Validator lets you check that your EPUB 2 files are valid IDPF documents
   with the help of the epubcheck tool.
 email: