epub_validator 0.1.0 → 0.1.1

data/README.md

@@ -15,26 +15,26 @@ gem install epub_validator
 
 ## Basic Usage
 
-Sample usage and output for a missing EPUB file:
+Sample usage and output:
 
 ``` ruby
 require 'epub_validator'
 
-ev = EpubValidator.check_file('/path/to/missing.epub')
+ev = EpubValidator.check('/path/to/sample.epub')
 ev.message.each do |m|
   puts m
 end
 => # FAILED!
-=> # ERROR: /path/to/missing.epub: I/O error: path/to/missing.epub (No such file or directory)
+=> # ERROR: OPS/toc.ncx(21): 'OPS/': referenced resource exists, but not declared in the OPF file
 ```
 
 Now from the command line:
 
 ``` terminal
-$ epub_validator /path/to/missing.epub
+$ bin/epub_validator /path/to/sample.epub
 Checking....
 FAILED!
-ERROR: /path/to/missing.epub: I/O error: /path/to/missing.epub (No such file or directory)
+ERROR: OPS/toc.ncx(21): 'OPS/': referenced resource exists, but not declared in the OPF file
 ```
 
 
@@ -44,6 +44,6 @@ Java must be installed and set in your PATH.
 
 ## Future Features
 
-* Accept directory containing many .epub files for processing.
-* Write results to log file.
-* Format "error" output for more intuitive instructions.
+* Accept a directory containing many .epub files for processing.
+* When using the command line, have option to write results to a log file
+* Format "ERROR" and "WARNING" output for more intuitive instructions.

data/bin/epub_validator

@@ -15,6 +15,6 @@ command = args.shift.strip rescue 'help'
 #EpubValidator::Command.run(command, args)
 
 puts "Checking...."
-ev = EpubValidator.check_file(command)
-puts ev.message
+ev = EpubValidator.check(command)
+puts ev
 

data/epub_validator.gemspec

@@ -7,12 +7,12 @@ Gem::Specification.new do |s|
 
   s.name        = "epub_validator"
   s.version     = EpubValidator::VERSION
-  s.summary     = %q{Run epubcheck.jar on single/multiple EPUB files.}
-  s.description = %q{EPUB Validator allows you to check your EPUB files for errors using the epubcheck Java file. You can check just one file at a time for now - eventually directories full of EPUB files and then output any errors to a log file.}
+  s.summary     = %q{Check that your EPUB book is a valid IDPF document.}
+  s.description = %q{EPUB Validator lets you check that your EPUB 2 files are valid IDPF documents with the help of the epubcheck tool.}
 
   s.authors     = ["Mike Cook"]
   s.email       = ["m@mikecook.co.uk"]
-  s.homepage    = "http://mikecook.co.uk"
+  s.homepage    = "https://github.com/mrcook/"
 
   s.required_ruby_version     = ">= 1.9.2"
   s.required_rubygems_version = ">= 1.3.6"
@@ -22,11 +22,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # Examples
-  #s.add_dependency('posix-spawn', "~> 0.3.6")
-  #s.add_runtime_dependency "rest-client"
-
-  s.add_dependency "rspec"
-  s.add_dependency "ZenTest"
-  s.add_dependency "autotest-growl"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "ZenTest"
+  s.add_development_dependency "autotest-growl"
 end

data/lib/epub_validator.rb

@@ -1,10 +1,11 @@
 Dir["#{File.dirname(__FILE__)}/epub_validator/**/*"].each {|file| require(file)}
 
-require 'epub_validator/check_epub'
+require 'epub_validator/process_epub'
 
 module EpubValidator
-  def self.check_file(filename)
-    CheckEpub.new(filename)
+  def self.check(filename)
+    validation = ProcessEpub.new
+    validation.epubcheck(filename)
   end
 end
 

data/lib/epub_validator/format_message.rb

@@ -0,0 +1,18 @@
+module EpubValidator
+  class FormatMessage
+    def process_message(message)
+      return ['Passed.'] if message.match('No errors or warnings detected')
+
+      m_array = message.split(/\n/)
+
+      # clean up all useless info
+      m_array.delete_if do |s|
+        s.empty? or
+          s.match('^Epubcheck Version.*') or
+          s.match('^Check finished.*')
+      end
+
+      m_array.unshift('FAILED!')
+    end
+  end
+end

data/lib/epub_validator/process_epub.rb

@@ -0,0 +1,13 @@
+module EpubValidator
+  class ProcessEpub
+    def epubcheck(filename)
+      epubcheck_jar = File.expand_path(File.dirname(__FILE__) + '/../epubcheck-1-2/epubcheck-1.2.jar')
+      format_epubcheck_output(`java -jar #{epubcheck_jar} "#{filename}" 2>&1`)
+    end
+
+    def format_epubcheck_output(message)
+      errm = FormatMessage.new
+      errm.process_message(message)
+    end
+  end
+end

data/lib/epub_validator/version.rb

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

data/spec/epub_validator/format_message_spec.rb

@@ -0,0 +1,29 @@
+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
+        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)"]
+        errm = FormatMessage.new
+        errm.process_message(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
+        message = "Epubcheck Version 1.2\n\nNo errors or warnings detected\n"
+        errm = FormatMessage.new
+        errm.process_message(message).should eq(['Passed.'])
+      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"]
+        errm = FormatMessage.new
+        errm.process_message(message).should eq(formatted_message)
+      end
+    end
+  end
+end

data/spec/epub_validator/process_epub_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module EpubValidator
+  describe ProcessEpub do
+    context "when it processes a file" do
+      it "should return a message" do
+        message = "Epubcheck Version 1.2\n\nERROR: rspec-test.epub: resource OEBPS/stylesheets/handbookish.css is missing\n\nCheck finished with warnings or errors!"
+        ec = ProcessEpub.new
+        ec.stub(:epubcheck).and_return(message)
+        ec.epubcheck("test.epub").should eq(message)
+      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"]
+        ec = ProcessEpub.new
+        ec.format_epubcheck_output(message).should eq(formatted_message)
+      end
+    end
+  end
+end

data/spec/epub_validator_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe EpubValidator do
   context "when given a single EPUB filename" do
-    it "should validate the file"
+    #it "should validate the file"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epub_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,44 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-29 00:00:00.000000000Z
+date: 2011-11-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11655920 !ruby/object:Gem::Requirement
+  requirement: &11670320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *11655920
+  version_requirements: *11670320
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &11654780 !ruby/object:Gem::Requirement
+  requirement: &11669320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *11654780
+  version_requirements: *11669320
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &11653840 !ruby/object:Gem::Requirement
+  requirement: &11668720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *11653840
-description: EPUB Validator allows you to check your EPUB files for errors using the
-  epubcheck Java file. You can check just one file at a time for now - eventually
-  directories full of EPUB files and then output any errors to a log file.
+  version_requirements: *11668720
+description: EPUB Validator lets you check that your EPUB 2 files are valid IDPF documents
+  with the help of the epubcheck tool.
 email:
 - m@mikecook.co.uk
 executables:
@@ -63,7 +62,8 @@ files:
 - bin/epub_validator
 - epub_validator.gemspec
 - lib/epub_validator.rb
-- lib/epub_validator/check_epub.rb
+- lib/epub_validator/format_message.rb
+- lib/epub_validator/process_epub.rb
 - lib/epub_validator/version.rb
 - lib/epubcheck-1-2/COPYING.txt
 - lib/epubcheck-1-2/README.txt
@@ -71,10 +71,11 @@ files:
 - lib/epubcheck-1-2/jing_license.txt
 - lib/epubcheck-1-2/lib/jing.jar
 - lib/epubcheck-1-2/lib/saxon.jar
-- spec/epub_validator/check_epub_spec.rb
+- spec/epub_validator/format_message_spec.rb
+- spec/epub_validator/process_epub_spec.rb
 - spec/epub_validator_spec.rb
 - spec/spec_helper.rb
-homepage: http://mikecook.co.uk
+homepage: https://github.com/mrcook/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -97,5 +98,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Run epubcheck.jar on single/multiple EPUB files.
+summary: Check that your EPUB book is a valid IDPF document.
 test_files: []

data/lib/epub_validator/check_epub.rb

@@ -1,30 +0,0 @@
-module EpubValidator
-  class CheckEpub
-    attr_accessor :message
-
-    def initialize(filename)
-      @filename = filename
-      @message = format_epubcheck_message(process_epub)
-    end
-
-    def process_epub
-      epubcheck_jar = File.expand_path(File.dirname(__FILE__) + '/../epubcheck-1-2/epubcheck-1.2.jar')
-      epubcheck = `java -jar #{epubcheck_jar} "#{@filename}" 2>&1`
-    end
-
-    def format_epubcheck_message(message)
-      return ['Passed.'] if message.match('No errors or warnings detected')
-
-      m_array = message.split(/\n/)
-
-      # clean up all useless info
-      m_array.delete_if do |s|
-        s.empty? or
-          s.match('^Epubcheck Version.*') or
-          s.match('^Check finished.*')
-      end
-
-      m_array.unshift('FAILED!')
-    end
-  end
-end

data/spec/epub_validator/check_epub_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-module EpubValidator
-  describe CheckEpub do
-    context "when it tries to process a missing file" do
-      it "should return missing file error message" do
-        failed_message = 'FAILED!\n\nNo .epub file to check was specified in arguments!\n\nThe tool will EXIT!'
-        ce = CheckEpub.new('test.epub')
-        CheckEpub.any_instance.stub(:process_epub).and_return(failed_message)
-        ce.process_epub.should eq(failed_message)
-      end
-    end
-    context "when it processes a valid file" do
-      it "should return 'Passed.' message as an array" do
-        success_message = "Epubcheck Version 1.2\n\nNo errors or warnings detected\n"
-        ce = CheckEpub.new('test.epub')
-        ce.format_epubcheck_message(success_message).should eq(['Passed.'])
-      end
-    end
-    context "when it processes an invalid file" do
-      it "should return error message as an array" do
-        failed_message = "Epubcheck Version 1.2\n\nERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing\n\nCheck finished with warnings or errors!"
-        formatted_failed_message = ["FAILED!", "ERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing"]
-        ce = CheckEpub.new('test.epub')
-        ce.format_epubcheck_message(failed_message).should eq(formatted_failed_message)
-      end
-    end
-  end
-end