djvu-tools 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Evan Boyd Sosenko
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,83 @@
+= DjVu-Tools
+
+== What is DjVu-Tools?
+
+DjVu-Tools is a Ruby library for manipulating DjVu files. The interface is built on the DjVuLibre djvused[http://djvu.sourceforge.net/doc/man/djvused.html] command line tool provided by DjVuLibre[http://djvu.sourceforge.net/index.html]. Current tools include:
+
+* Easy page title management for page number generation.
+  The only way to achieve consistent page numbering for most books is to set the page title for each page.
+  The DjVuNumberer class provides  a way to title individual pages and number ranges of pages in various styles.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'djvu-tools'
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install djvu-tools
+
+== Using DjVu-Tools
+
+=== Numberer
+
+Fist pick a file to work on:
+
+  djvu = DjVuNumberer.new 'book.djvu'
+
+Then create sections to title or number:
+
+* A single page
+
+    djvu.add_section( { title: 'Cover', range: (1..1) } )
+
+* A range of pages with uppercase Roman numerals starting with I:
+
+    djvu.add_section( { start: 1, range: (2..10), type: :upper_roman } )
+
+* A range of pages with lowercase Roman numerals starting with x:
+
+    djvu.add_section( { start: 10, range: (11..20), type: :lower_roman } )
+
+* A range of pages with Arabic numerals starting with 1:
+
+    djvu.add_section( { start: 1, range: (21..500), type: :arabic } )
+
+Finally, you must run djvused and write to the file with
+
+    djvu.run
+
+If you get an error such as
+
+    File with TITLE 'foo' already exists in the DJVM directory.
+
+then a page with the same title already exists (this may be case intensive). You may wish to first relabel all of the pages with a range of numbers you will not use before you attempt again.
+
+== Development
+
+=== Source Repository
+
+DjVu-Tools is currently hosted at github. The github web page is
+https://github.com/razor-x/DjVu-Tools. To clone the project run
+
+  $ git clone git://github.com/razor-x/DjVu-Tools.git
+
+After cloning, you should run yard to generate documentation for the source.
+
+== License
+
+DjVu-Tools is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/djvu-tools.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path( '../lib/djvu-tools/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Evan Boyd Sosenko']
+  gem.email         = ['razorx@evansosenko.com']
+  gem.description   = %q{Ruby toolbox for manipulating DjVu files.}
+  gem.summary       = %q{Ruby library for djvused. Currenly tools include: easy page title management for page number generation.}
+  gem.homepage      = "http://evansosenko.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'djvu-tools'
+  gem.require_paths = ['lib']
+  gem.platform      = Gem::Platform::RUBY
+  gem.version       = DjVuTools::VERSION
+
+  gem.add_dependency 'roman-numerals'
+  gem.add_dependency 'which'
+
+  gem.add_development_dependency 'rspec'
+
+  gem.requirements  << 'djvused'
+end

data/lib/djvu-tools/djvu-numberer.rb

@@ -0,0 +1,34 @@
+# Page title management for page number generation
+class DjVuNumberer < DjVuTools
+
+  # @see ObjectName#method
+  def initialize file
+    super
+    @sections = []
+  end
+
+  # Add a labeled section.
+  # @param [Hash] section
+  # @see file:README.rdoc The Numberer section in the README
+  def add_section section
+
+    if section[:start].nil?
+      raise ArgumentError, 'Cannot label a range of pages with the same title' if ( section[:range].max - section[:range].min > 0 )
+      section[:range].each { |n| @djvu.title_page n, section[:title]  }
+    else
+      section[:range].each_with_index do |n, i|
+      number = section[:start] + i
+      number =
+        case section[:type]
+        when :arabic
+          number.to_s
+        when :upper_roman
+          RomanNumerals::to_roman(number).upcase
+        when :lower_roman
+          RomanNumerals::to_roman(number).downcase
+        end
+        @djvu.title_page n, "#{number}"
+      end
+    end
+  end
+end

data/lib/djvu-tools/djvused.rb

@@ -0,0 +1,31 @@
+# Interface to djvused.
+class DjVused
+
+  attr_reader :file
+  attr_accessor :command
+
+  # @see DjVused#new
+  def initialize file
+    raise SystemCallError, 'djvused command not found' if ( Which::which 'djvused' ).empty?
+
+    @file = File.expand_path file
+    raise RuntimeError, 'File not found' unless ( File.exists? @file )
+    @command = ""
+  end
+
+  # Appends command to set page title.
+  # @param [Integer] page number
+  # @param [String] title cannot contain single or double quotes
+  # @return [String] command string
+  def title_page page, title
+    raise ArgumentError, 'Argument is not an integer' unless page.is_a? Integer
+    raise ArgumentError, 'Argument is cannot contain a single or double quote' if title =~ /['"]/
+
+    @command << %Q{select #{page}; set-page-title "#{title}";}
+  end
+
+  # Runs djvused with command and saves to file.
+  def save
+    system *['djvused', '-s','-e', @command, @file]
+  end
+end

data/lib/djvu-tools/version.rb

@@ -0,0 +1,4 @@
+class DjVuTools
+  # Version number.
+  VERSION = "0.0.1"
+end

data/lib/djvu-tools.rb

@@ -0,0 +1,20 @@
+require 'roman-numerals'
+require 'which'
+
+require 'djvu-tools/version'
+require 'djvu-tools/djvused'
+require 'djvu-tools/djvu-numberer'
+
+# Ruby toolbox for manipulating DjVu files.
+class DjVuTools
+
+  # @see DjVused#new
+  def initialize file
+    @djvu = DjVused.new file
+  end
+
+  # Run djvused with the current command string.
+  def run
+    @djvu.save
+  end
+end

data/spec/djvu_numberer_spec.rb

@@ -0,0 +1,46 @@
+require 'djvu-tools/djvu-numberer'
+
+describe DjVuNumberer do
+
+  before :each do
+    File.stub(:exists?).and_return(true)
+    Which.stub(:which).and_return( ['djvused'] )
+    @numberer = DjVuNumberer.new 'input file.djvu'
+  end
+
+  describe ".add_section" do
+
+    it "titles a single page" do
+      section = { title: 'the title', range: (10..10) }
+      @numberer.instance_eval{ @djvu }.should_receive(:title_page).with(10, section[:title])
+      @numberer.add_section section
+    end
+
+    it "will not title a range of pages with a single title" do
+      section = { title: 'the title', range: (10..12) }
+      expect { @numberer.add_section section }.to raise_error ArgumentError
+    end
+
+    it "titles a range of pages with arabic numerals" do
+      section = { start: 42, range: (10..12), type: :arabic }
+      section[:range].each_with_index do |n, i|
+        @numberer.instance_eval{ @djvu }.should_receive(:title_page).with(n, "#{section[:start] + i}")
+      end
+      @numberer.add_section section
+    end
+
+    it "titles a range of pages with uppercase roman numerals" do
+      section = { start: 3, range: (10..11), type: :upper_roman }
+      @numberer.instance_eval{ @djvu }.should_receive(:title_page).with(10, "III")
+      @numberer.instance_eval{ @djvu }.should_receive(:title_page).with(11, "IV")
+      @numberer.add_section section
+    end
+
+    it "titles a range of pages with lowercaseroman numerals" do
+      section = { start: 9, range: (20..21), type: :lower_roman }
+      @numberer.instance_eval{ @djvu }.should_receive(:title_page).with(20, "ix")
+      @numberer.instance_eval{ @djvu }.should_receive(:title_page).with(21, "x")
+      @numberer.add_section section
+    end
+  end
+end

data/spec/djvused_spec.rb

@@ -0,0 +1,81 @@
+require 'djvu-tools/djvused'
+
+describe DjVused do
+
+  describe ".new" do
+
+    it "fails when djvused command is not installed" do
+      Which.stub(:which).and_return( [] )
+      expect { DjVused.new 'input.djvu' }.to raise_error SystemCallError
+    end
+
+    it "fails when file does not exist" do
+      File.stub(:exists?).and_return(false)
+      expect { DjVused.new 'input.djvu' }.to raise_error RuntimeError
+    end
+
+    it "creates a new object with path to input file" do
+      File.stub(:exists?).and_return(true)
+      djvu = DjVused.new 'input.djvu'
+      djvu.file.should eql ( File.expand_path 'input.djvu' )
+    end
+  end
+
+  context "when a new DjVused object can be created" do
+
+    before :each do
+      File.stub(:exists?).and_return(true)
+      Which.stub(:which).and_return( ['djvused'] )
+      @djvu = DjVused.new 'input file.djvu'
+    end
+
+    describe ".title_page" do
+
+      context "when given bad arguments" do
+
+        it "fails if page number is not an integer" do
+          expect { @djvu.title_page '1', 'the title' }.to raise_error ArgumentError
+        end
+
+        it "fails if title contains single or double quotes" do
+          %W{ 'the title' "the title" 'the title" }.each do |w|
+            expect { @djvu.title_page 1, w }.to raise_error ArgumentError
+          end
+        end
+      end
+
+      context "when given valid arguments" do
+
+        before :each do
+          @args_1 = [ 1, 'the title' ]
+          @args_2 = [ 42, 'the other title' ]
+
+          def cmd args
+            %Q{select #{args[0]}; set-page-title "#{args[1]}";}
+          end
+        end
+
+        it "generates the command section to set a page title" do
+          ( @djvu.title_page *@args_1 ).should eql ( cmd @args_1 )
+        end
+
+        it "adds the command section to the full command" do
+          @djvu.title_page *@args_1
+          @djvu.title_page *@args_2
+
+          @djvu.command.should match /^#{cmd @args_1}/
+          @djvu.command.should match /#{cmd @args_2}$/
+        end
+      end
+    end
+
+    describe ".save" do
+
+      it "runs the command and saves to file" do
+        @djvu.command = 'full; command;'
+        @djvu.should_receive(:system).with('djvused', '-s', '-e', @djvu.command, an_instance_of(String) )
+        @djvu.save
+      end
+    end
+  end
+end

data/spec/djvutools_spec.rb

@@ -0,0 +1,18 @@
+require 'djvu-tools'
+
+describe DjVuTools do
+
+  before :each do
+    File.stub(:exists?).and_return(true)
+    Which.stub(:which).and_return( ['djvused'] )
+    @tool = DjVuTools.new 'input file.djvu'
+  end
+
+  describe ".run" do
+    it "calls save on the DjVused object" do
+      @tool.instance_eval{ @djvu }.should_receive(:save)
+      @tool.run
+    end
+  end
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: djvu-tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Evan Boyd Sosenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roman-numerals
+  requirement: &5110660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *5110660
+- !ruby/object:Gem::Dependency
+  name: which
+  requirement: &5110100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *5110100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &6112020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6112020
+description: Ruby toolbox for manipulating DjVu files.
+email:
+- razorx@evansosenko.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- djvu-tools.gemspec
+- lib/djvu-tools.rb
+- lib/djvu-tools/djvu-numberer.rb
+- lib/djvu-tools/djvused.rb
+- lib/djvu-tools/version.rb
+- spec/djvu_numberer_spec.rb
+- spec/djvused_spec.rb
+- spec/djvutools_spec.rb
+homepage: http://evansosenko.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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:
+- djvused
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: ! 'Ruby library for djvused. Currenly tools include: easy page title management
+  for page number generation.'
+test_files:
+- spec/djvu_numberer_spec.rb
+- spec/djvused_spec.rb
+- spec/djvutools_spec.rb
+has_rdoc: