EPUBChop 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTk5MTRjMjQ1ZDk2YTEzM2E3MWNkN2ViODEzYzdlYWQ4ODE0YWE4NA==
+  data.tar.gz: !binary |-
+    YzYyMTA1YmYzOWY1N2UwNWRlM2ZiOTIwMmU0NTRhNGQ2YjE3YTc3Nw==
+SHA512:
+  metadata.gz: !binary |-
+    MjI4ZDgzNWY0NzI3NmQ4YzAzNzNlNTZkMGMzZDA4MjIwMmVhOTQ4Y2EwODI5
+    ZWZjNDNkNDRhOWI4N2YxYWMxZjc5MDU2MjFkMTIzYWQ2MTk5YmI2YTczZjEx
+    ZWFjMWY4YTgwN2FkYjJiOGNlYTJhNTk5ZGY3N2VlZDE5MGU0NWM=
+  data.tar.gz: !binary |-
+    YWYyZDNiMDFkOGExMWY5MGFiM2Y4MDdkYWQ3MWNlMDkxMTQ2MDkzNzIxOWE1
+    Mzg3ZDBhNGVmMGJiZmQ0ODgzMmQzYmFkZWU2ZmNhYmZkMjUxMzc0NDQzNzE1
+    YWNhOGZhMTVmMzhiODFhMTY1ODAzNGE2MDI5YmE5MzI4MGI3ZmI=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode

data/EPUBChop.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'EPUBChop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "EPUBChop"
+  spec.version       = EPUBChop::VERSION
+  spec.authors       = ["Mehmet Celik"]
+  spec.email         = ["mehmet@celik.be"]
+  spec.description   = %q{Create EPUB previews}
+  spec.summary       = %q{Removes unwanted content from an EPUB}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "epubinfo_with_toc"
+  spec.add_runtime_dependency "rubyzip", "~> 1.0"
+  spec.add_runtime_dependency "nokogiri"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in EPUBChop.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Mehmet Celik
+
+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.md

@@ -0,0 +1,34 @@
+EPUBChop [![Continuous Integration](https://travis-ci.org/mehmetc/EPUBChop.png?branch=master)](http://travis-ci.org/mehmetc/EPUBChop)
+========
+
+Creates EPUB previews
+
+```
+$ ./bin/epubchop --help
+EPUBChop will create a preview version of an EPUB file.
+
+Usage:
+      epubchop [options] <filename>
+
+where [options] are:
+  --words, -w <i>:   the amount of words to put in the preview (default: 10)
+   --base, -b <s>:   if given the base value of the amount of words is ... Possible values percentage (default: percentage)
+  --line1, -l <s>:   Text that is shown on line 1 of the chopped of pages (default: Continue reading?)
+  --line2, -i <s>:   Text that is shown on line 2 of the chopped of pages (default: Go to your local library or buy the book.)
+       --help, -h:   Show this message
+```
+
+### Example:
+```ruby
+epubchop --words 10 --base percentage -line1 "Want to read more?" -line2 "Buy the book!" my.epub
+```
+
+## Contributing to EPUBChop
+* Fork the project.
+* Create a new branch to implement your bugfixes or features
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+
+## Copyright
+
+Copyright (c) 2013 LIBIS/KULeuven, Mehmet Celik. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+desc "run tests"
+task :default => :spec

data/bin/epubchop

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << './lib'
+require 'EPUBChop'
+require 'trollop'
+
+options = Trollop::options do
+  version = "EPUBChop #{EPUBChop::VERSION} (c) 2013 LIBIS/KULeuven, Mehmet Celik"
+  banner <<-BANNER
+EPUBChop will create a preview version of an EPUB file.
+
+Usage:
+      epubchop [options] <filename>
+
+where [options] are:
+BANNER
+
+  opt :words, "the amount of words to put in the preview", :type => :int, :default => 10
+  opt :base,  "How to interprete the --words options... Possible value: percentage", :type => :string, :default => 'percentage'
+  opt :line1, "Text that is shown on line 1 of the chopped pages", :type => :string, :default => 'Continue reading?'
+  opt :line2, "Text that is shown on line 2 of the chopped pages", :type => :string, :default => 'Go to your local library or buy the book.'
+end
+
+Trollop::die "need an EPUB file name" if ARGV.empty?
+
+
+begin
+    filename = File.expand_path(ARGV[0])
+    words = options[:words]
+    base  = options[:base]
+    text  = []
+    text << options[:line1] if options.has_key?(:line1)
+    text << options[:line2] if options.has_key?(:line2)
+
+    puts 'loading EPUB'
+    b=EPUBChop.get(filename)
+    puts 'chopping EPUB'
+    c=b.chop({:base => base.to_s, :words => words, :text => text})
+    puts 'rebuilding EPUB'
+    FileUtils.move(c, "chopped_#{File.basename(filename)}")
+
+rescue Exception => e
+  puts "An error occured\n#{e.message}"
+  exit 1
+end

data/lib/EPUBChop/chop.rb

@@ -0,0 +1,209 @@
+require 'nokogiri'
+require 'epubinfo'
+require 'tempfile'
+require 'zip'
+
+module EPUBChop
+  class Chop
+    attr_reader :book, :words, :base, :resource_word_count, :resource_allowed_word_count, :text1, :text2
+
+    def initialize(input, options ={})
+      set_defaults(options)
+
+
+      raise 'Please supply an input file name' if input.nil?
+
+      #count the number of words in a file
+      @resource_word_count = count_words(input)
+
+    end
+
+    def total_words
+      @resource_word_count.values.inject(0) { |sum, i| sum + i }
+    end
+
+    def resource_allowed_word_count
+      #figure out what to return
+      @resource_allowed_word_count ||= files_allowed(allowed_words(@words, @base))
+    end
+
+    def chop(options = {})
+      set_defaults(options)
+
+      original_zip_file = @book.table_of_contents.parser.zip_file
+      #unzip in temp dir
+      extract_dir = Dir.mktmpdir('epub_extract')
+      original_zip_file.entries.each do |e|
+        file_dir = File.split(e.name)[0]
+        Dir.mkdir(File.join(extract_dir, file_dir)) unless Dir.exists?(File.join(extract_dir, file_dir)) || file_dir.eql?(".")
+        original_zip_file.extract(e, File.join(extract_dir, e.name))
+      end
+
+      #fix spine files
+      filename_list = @resource_word_count.keys
+      filename_list.each do |filename|
+        original_file_size = @resource_word_count[filename]
+        processed_file_size = resource_allowed_word_count[filename]
+
+        if original_file_size != processed_file_size
+          if processed_file_size == 0
+            FileUtils.rm("#{extract_dir}/#{filename}", :force => true)
+            FileUtils.touch "#{extract_dir}/#{filename}"
+            File.open("#{extract_dir}/#{filename}", 'w') do |f|
+              f.puts empty_file
+            end
+
+          else
+            resource = Nokogiri::XML(@book.table_of_contents.resources[filename]) do |config|
+              config.noblanks.nonet
+            end
+            resource.css('script').remove
+            resource.css('style').remove
+            resource_text = resource.at_css('body').text.split[0..processed_file_size]
+            resource_text_length = resource_text.length
+
+            # get a string that can be found
+            data = nil
+            window_begin = 5
+            window_end = 0
+            while data.nil?
+              look_for = resource_text[(processed_file_size - window_begin)..(processed_file_size - window_end)].join(' ')
+              data = resource.at_css("p:contains('#{look_for}')")
+              window_begin += 1
+              window_end += 1
+            end
+
+            #limit on found string
+            if data
+              next_data = data.next_element
+              while next_data
+                in_resource = resource.css(next_data.css_path)
+                in_resource.remove
+
+                next_data = data.nil? || data.next_element.to_s.length == 1 ? nil : data.next_element
+              end
+            end
+
+            #persist page
+            File.open("#{extract_dir}/#{filename}", 'w') do |f|
+              f.puts resource.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+            end
+
+          end
+        end
+      end
+      #TODO:remove unwanted media
+
+      #zip new ebook
+      new_ebook_name = Tempfile.new(['epub', '.epub'], Dir.tmpdir)
+      new_ebook_name_path = new_ebook_name.path
+      new_ebook_name_path.gsub!('-', '')
+
+      zipfile = Zip::File.open(new_ebook_name_path, Zip::File::CREATE)
+
+      Dir[File.join(extract_dir, '**', '**')].each do |file|
+        zipfile.add(file.sub("#{extract_dir}/", ''), file)
+      end
+      zipfile.close
+
+      return new_ebook_name_path
+    rescue Zip::ZipError => e
+      raise RuntimeError, ''
+    rescue Exception => e
+      puts "Chopping went wrong. #{e.message}"
+      puts e.backtrace
+
+      return nil
+    ensure
+      FileUtils.remove_entry_secure(extract_dir)
+    end
+
+    private
+
+    def set_defaults(options)
+      @words = options[:words] || 10
+      @base = options[:base] || :percentage
+      if options[:text].is_a?(Array)
+        @text1 = options[:text][0] || 'Continue reading?'
+        @text2 = options[:text][1] || 'Go to your local library or buy the book.'
+      else
+        @text1 = options[:text] || 'Continue reading? Go to your local library or buy the book.'
+        @text2 = ''
+      end
+    end
+
+    def empty_file
+      data = <<DATA
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>Read more</title>
+</head>
+<body>
+<center>
+<div style='width:100%;border:1px solid black;margin-top:20px;padding:5px'>
+<div><h2>#{@text1}</h2></div>
+<div><h2>#{@text2}</h2></div>
+</div>
+</center>
+</body>
+</html>
+DATA
+    end
+
+    def count_words(input)
+      @book = EPUBInfo.get(input)
+      resource_word_count = {}
+      if @book
+        @book.table_of_contents.resources.spine.each do |resource|
+          raw = Nokogiri::HTML(@book.table_of_contents.resources[resource[:uri]]) do |config|
+            config.noblanks.nonet
+          end
+          raw.css('script').remove
+          raw.css('style').remove
+          size = raw.at_css('body').text.split.size
+          resource_word_count.store(resource[:uri], size)
+        end
+      end
+      # resource_word_count.values.inject(0){|sum, i| sum + i}
+      resource_word_count
+    end
+
+    def allowed_words(words, base)
+      @allowed_words ||= begin
+        case base.to_s
+          when 'percentage'
+            @allowed_words = (total_words * (words / 100.0)).to_i
+          else
+            @allowed_words = words
+        end
+      end
+
+    end
+
+    def files_allowed(allowed_words)
+      word_counter = 0
+      resource_allowed_word_count = @resource_word_count.select do |r|
+        (word_counter += @resource_word_count[r]) < allowed_words
+      end
+      word_counter = resource_allowed_word_count.values.inject(0) { |sum, i| sum + i }
+
+      how_many_words_left = allowed_words - word_counter
+      if how_many_words_left > 0
+        resource_to_split_name = @resource_word_count.keys[resource_allowed_word_count.length]
+        word_count_of_resource_to_split = @resource_word_count[resource_to_split_name]
+        if  how_many_words_left < word_count_of_resource_to_split
+          resource_allowed_word_count.store(resource_to_split_name, how_many_words_left)
+        end
+      end
+
+      @resource_word_count.keys[resource_allowed_word_count.length..@resource_word_count.length].each do |r|
+        resource_allowed_word_count.store(r, 0)
+      end
+
+      resource_allowed_word_count
+    end
+
+  end
+end

data/lib/EPUBChop/version.rb

@@ -0,0 +1,3 @@
+module EPUBChop
+  VERSION = "0.0.1"
+end

data/lib/EPUBChop.rb

@@ -0,0 +1,9 @@
+require "EPUBChop/version"
+require 'EPUBChop/chop'
+
+
+module EPUBChop
+  def self.get(path, options = {})
+    EPUBChop::Chop.new(path, options)
+  end
+end