cbr_to_epub 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e5bed551d5f54c32e132f64f8d45acc2ef708da
+  data.tar.gz: 46f8007dc1074e7832d6d2b1445951dc79735e96
+SHA512:
+  metadata.gz: 5d47ff54bc077963bd6e13cb2d3baf5b9769019fea8e3ac3e98460196f6a35dfcb920c32577523d381c20df5d76d9dc9e60939a6275c307cf971dc10ef9b70ec
+  data.tar.gz: fd72ba024a0c9dfac868fe3d7e27dfc66bfc262f036703ad0469fb35d6271830670d861c2694e88e6da5a216c9b573454c2051ae46836aa74424ec5c07d28324

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rafal Cymerys
+
+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,35 @@
+# Cbr to Epub Converter
+
+This gem lets you convert .cbr and .cbz comic books to epub files.
+This may come in handy if you want to be able to read them on your iPad.
+
+The tool has been written for and tested on macOS, so if you want to use it on other platforms you'll need to port Input::CbrExtractor and Output::EpubCompressor classes, as they rely on shell utilities for macOS system.
+
+## Installation
+
+In order to use it, make sure you have unrar installed in your system. You can do it via homebrew:
+
+`brew install unrar`
+
+Then install the gem:
+
+`gem install cbr_to_epub`
+
+## Usage
+
+`cbr_to_epub -i input.cbr`
+
+You can also specify author and title for metadata that will be embedded in the epub file:
+
+`cbr_to_epub -i input.cbr --title "Batman 1" --author "Comic Book Guy"`
+
+Use `-o` option if you want to specify output file manually.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rafalcymerys/cbr_to_epub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cbr_to_epub"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cbr_to_epub.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cbr_to_epub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cbr_to_epub'
+  spec.version       = CbrToEpub::VERSION
+  spec.authors       = ['Rafal Cymerys']
+  spec.email         = ['rafal@latenightcoding.co']
+
+  spec.summary       = %q{A simple gem for converting cbr files to epub}
+  spec.homepage      = 'https://rubygems.org/gems/cbr_to_epub'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/exe/cbr_to_epub

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby
+
+require 'optparse'
+require_relative '../lib/cbr_to_epub'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: cbr_to_epub [options]'
+
+  opts.on('-i', '--input FILE', 'Input CBR file to be converted') do |input|
+    options[:input] = input
+  end
+
+  opts.on('-o', '--output FILE', 'Output EPUB file that will be created') do |output|
+    options[:output] = output
+  end
+
+  opts.on('-a', '--author [AUTHOR]', 'Add author to metadata') do |author|
+    options[:author] = author
+  end
+
+  opts.on('-t', '--title [TITLE]', 'Add title to metadata') do |title|
+    options[:title] = title
+  end
+end.parse!
+
+raise 'No input file specified' unless options[:input]
+
+metadata = CbrToEpub::Output::Content::Metadata.new(options[:author], options[:title])
+
+converter = CbrToEpub::Converter.new(options[:input], options[:output] || (options[:input] + '.epub'), metadata)
+converter.convert

data/lib/cbr_to_epub.rb

@@ -0,0 +1,5 @@
+require_relative 'cbr_to_epub/version'
+require_relative 'cbr_to_epub/converter'
+
+module CbrToEpub
+end

data/lib/cbr_to_epub/converter.rb

@@ -0,0 +1,38 @@
+require_relative 'file_manager'
+require_relative 'input/extractor_factory'
+require_relative 'output/content/data'
+require_relative 'output/content/metadata'
+require_relative 'output/epub_builder'
+require_relative 'output/epub_compressor'
+
+module CbrToEpub
+  class Converter
+    def initialize(input_path, output_path, metadata)
+      @input_path = input_path
+      @output_path = output_path
+      @metadata = metadata
+      @file_manager = FileManager.new
+    end
+
+    def convert
+      file_manager.create
+      extractor = Input::ExtractorFactory.new(file_manager).for_file(input_path)
+      input_image_files = extractor.extract
+
+      epub_builder = Output::EpubBuilder.new(file_manager, Output::Content::Data.new(metadata, input_image_files))
+      epub_builder.generate_metadata
+      epub_builder.generate_pages
+      epub_builder.generate_images
+
+      epub_compressor = Output::EpubCompressor.new(file_manager)
+      epub_compressor.compress
+      epub_compressor.copy(output_path)
+    ensure
+      file_manager.cleanup
+    end
+
+    private
+
+    attr_reader :input_path, :output_path, :metadata, :file_manager
+  end
+end

data/lib/cbr_to_epub/file_manager.rb

@@ -0,0 +1,26 @@
+require 'fileutils'
+require 'tmpdir'
+
+module CbrToEpub
+  class FileManager
+    attr_reader :directory
+
+    def create
+      @directory = Dir.mktmpdir
+      Dir.mkdir(extracted_directory)
+      Dir.mkdir(epub_directory)
+    end
+
+    def extracted_directory
+      File.join(directory, 'extracted')
+    end
+
+    def epub_directory
+      File.join(directory, 'epub')
+    end
+
+    def cleanup
+      FileUtils.rm_rf(directory)
+    end
+  end
+end

data/lib/cbr_to_epub/input/cbr_extractor.rb

@@ -0,0 +1,21 @@
+module CbrToEpub
+  module Input
+    class CbrExtractor
+      def initialize(file_manager, input_path)
+        @file_manager = file_manager
+        @input_path = input_path
+      end
+
+      def extract
+        system("unrar e \"#{input_path}\" \"#{file_manager.extracted_directory}\"")
+
+        pattern = File.join(file_manager.extracted_directory, '**', '*.{jpg,jpeg,png,JPG,JPEG}')
+        Dir.glob(pattern).sort
+      end
+
+      private
+
+      attr_reader :file_manager, :input_path
+    end
+  end
+end

data/lib/cbr_to_epub/input/cbz_extractor.rb

@@ -0,0 +1,21 @@
+module CbrToEpub
+  module Input
+    class CbzExtractor
+      def initialize(file_manager, input_path)
+        @file_manager = file_manager
+        @input_path = input_path
+      end
+
+      def extract
+        system("unzip -j \"#{input_path}\" -d \"#{file_manager.extracted_directory}\"")
+
+        pattern = File.join(file_manager.extracted_directory, '**', '*.{jpg,jpeg,png,JPG,JPEG}')
+        Dir.glob(pattern).sort
+      end
+
+      private
+
+      attr_reader :file_manager, :input_path
+    end
+  end
+end

data/lib/cbr_to_epub/input/extractor_factory.rb

@@ -0,0 +1,25 @@
+require_relative 'cbz_extractor'
+require_relative 'cbr_extractor'
+
+module CbrToEpub
+  module Input
+    class ExtractorFactory
+      def initialize(file_manager)
+        @file_manager = file_manager
+      end
+
+      def for_file(file)
+        extension = File.extname(file)
+        if extension == '.cbz'
+          CbzExtractor.new(file_manager, file)
+        else
+          CbrExtractor.new(file_manager, file)
+        end
+      end
+
+      private
+
+      attr_reader :file_manager
+    end
+  end
+end

data/lib/cbr_to_epub/output/content/data.rb

@@ -0,0 +1,21 @@
+require 'securerandom'
+require_relative 'page'
+
+module CbrToEpub
+  module Output
+    module Content
+      class Data
+        attr_reader :metadata, :pages
+
+        def initialize(metadata, input_image_files)
+          @metadata = metadata
+          @pages = input_image_files.each_with_index.map { |image_file, index| Page.new(index, image_file)}
+        end
+
+        def erb_binding
+          binding
+        end
+      end
+    end
+  end
+end

data/lib/cbr_to_epub/output/content/metadata.rb

@@ -0,0 +1,20 @@
+module CbrToEpub
+  module Output
+    module Content
+      class Metadata
+        DEFAULT_AUTHOR = 'Unknown'.freeze
+        DEFAULT_TITLE = 'Comic Book'.freeze
+
+        private_constant :DEFAULT_AUTHOR, :DEFAULT_TITLE
+
+        attr_reader :author, :title, :uuid
+
+        def initialize(author, title)
+          @author = author || DEFAULT_AUTHOR
+          @title = title || DEFAULT_TITLE
+          @uuid = SecureRandom.uuid
+        end
+      end
+    end
+  end
+end

data/lib/cbr_to_epub/output/content/page.rb

@@ -0,0 +1,30 @@
+module CbrToEpub
+  module Output
+    module Content
+      class Page
+        attr_reader :number, :input_image_file
+
+        def initialize(number, input_image_file)
+          @number = number
+          @input_image_file = input_image_file
+        end
+
+        def page_file
+          "#{number}.xhtml"
+        end
+
+        def image_file
+          "#{number}.jpg"
+        end
+
+        def image_media_type
+          'image/jpeg'
+        end
+
+        def erb_binding
+          binding
+        end
+      end
+    end
+  end
+end

data/lib/cbr_to_epub/output/epub_builder.rb

@@ -0,0 +1,58 @@
+require 'fileutils'
+require 'erb'
+
+module CbrToEpub
+  module Output
+    class EpubBuilder
+      def initialize(file_manager, data)
+        @file_manager = file_manager
+        @data = data
+      end
+
+      def generate_metadata
+        Dir.mkdir(File.join(output_directory, 'META-INF'))
+        Dir.mkdir(File.join(output_directory, 'OEBPS'))
+
+        copy_template('mimetype')
+        copy_template('META-INF/container.xml')
+        copy_template('OEBPS/style.css')
+        render_template('OEBPS/content.opf', data)
+        render_template('OEBPS/toc.ncx', data)
+      end
+
+      def generate_pages
+        data.pages.each do |page|
+          render_template('OEBPS/page.xhtml', page, output_file_name = File.join('OEBPS', page.page_file))
+        end
+      end
+
+      def generate_images
+        data.pages.each do |page|
+          FileUtils.copy(page.input_image_file, File.join(output_directory, 'OEBPS/', page.image_file))
+        end
+      end
+
+      private
+
+      attr_reader :file_manager, :data
+
+      def copy_template(file_name)
+        FileUtils.copy(File.join(template_directory, file_name), File.join(output_directory, file_name))
+      end
+
+      def render_template(file_name, bind_object, output_file_name = nil)
+        template = File.read(File.join(template_directory, file_name + '.erb'))
+        rendered_template = ERB.new(template).result(bind_object.erb_binding)
+        File.write(File.join(output_directory, output_file_name || file_name), rendered_template)
+      end
+
+      def template_directory
+        File.join(__dir__, '../../template/')
+      end
+
+      def output_directory
+        file_manager.epub_directory
+      end
+    end
+  end
+end

data/lib/cbr_to_epub/output/epub_compressor.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+
+module CbrToEpub
+  module Output
+    class EpubCompressor
+      def initialize(file_manager)
+        @file_manager = file_manager
+      end
+
+      def compress
+        # mimetype needs to be the first file in epub archive
+        system("cd \"#{file_manager.epub_directory}\" && zip -0 -rX \"#{zip_path}\" mimetype")
+        system("cd \"#{file_manager.epub_directory}\" && zip -0 -rX \"#{zip_path}\" * -x mimetype")
+      end
+
+      def copy(path)
+        FileUtils.copy(zip_path, path)
+      end
+
+      def zip_path
+        File.join(file_manager.directory, 'output.epub')
+      end
+
+      private
+
+      attr_reader :file_manager
+    end
+  end
+end

data/lib/cbr_to_epub/version.rb

@@ -0,0 +1,3 @@
+module CbrToEpub
+  VERSION = '1.0.0'
+end

data/lib/template/META-INF/container.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+  <rootfiles>
+    <rootfile full-path="OEBPS/content.opf" media-type="application/oebps-package+xml"/>
+  </rootfiles>
+</container>

data/lib/template/OEBPS/content.opf.erb

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<package xmlns="http://www.idpf.org/2007/opf" unique-identifier="BookID" version="2.0">
+  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
+    <dc:title><%= metadata.title %></dc:title>
+    <dc:creator opf:role="aut"><%= metadata.author %></dc:creator>
+    <dc:language>en</dc:language>
+    <dc:identifier id="BookID" opf:scheme="URN"><%= metadata.uuid %></dc:identifier>
+    <meta name="cover" content="image_0"/>
+  </metadata>
+  <manifest>
+    <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml"/>
+    <item id="css" href="style.css" media-type="text/css"/>
+    <% pages.each do |page| %>
+        <item id="page_<%= page.number %>" href="<%= page.page_file %>" media-type="application/xhtml+xml"/>
+        <item id="image_<%= page.number %>" href="<%= page.image_file %>" media-type="<%= page.image_media_type %>"/>
+    <% end %>
+  </manifest>
+  <spine toc="ncx">
+    <% pages.each do |page| %>
+        <itemref idref="page_<%= page.number %>"/>
+    <% end %>
+  </spine>
+</package>

data/lib/template/OEBPS/page.xhtml.erb

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" xmlns:epub="http://www.idpf.org/2007/ops">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+  <title>Comic Book</title>
+  <link rel="stylesheet" href="style.css"/>
+</head>
+<body>
+<div id="comic-book-page">
+  <img class="image" src="<%= image_file %>" alt="Page"/>
+</div>
+</body>
+</html>

data/lib/template/OEBPS/style.css

@@ -0,0 +1,12 @@
+#comic-book-page {
+    height: 99%;
+    width: 100%;
+    text-align: center;
+    page-break-inside: avoid;
+}
+
+#comic-book-page .image {
+    display: inline-block;
+    height: 100%;
+    margin: 0 auto;
+}

data/lib/template/OEBPS/toc.ncx.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE ncx PUBLIC "-//NISO//DTD ncx 2005-1//EN"
+   "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd">
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
+    <head>
+        <meta name="dtb:uid"
+              content="<%= metadata.uuid %>>"/>
+        <meta name="dtb:depth" content="1"/>
+        <meta name="dtb:totalPageCount" content="<%= pages.size %>"/>
+        <meta name="dtb:maxPageNumber" content="<%= pages.size %>"/>
+    </head>
+    <docTitle>
+        <text><%= metadata.title %></text>
+    </docTitle>
+    <navMap>
+        <% pages.each do |page| %>
+            <navPoint id="navPoint-<%= page.number %>" playOrder="<%= page.number %>">
+                <navLabel>
+                    <text>Page <%= page.number %></text>
+                </navLabel>
+                <content src="<%= page.page_file %>"/>
+            </navPoint>
+        <% end %>
+    </navMap>
+</ncx>

data/lib/template/mimetype

@@ -0,0 +1 @@
+application/epub+zip

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: cbr_to_epub
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rafal Cymerys
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- rafal@latenightcoding.co
+executables:
+- cbr_to_epub
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cbr_to_epub.gemspec
+- exe/cbr_to_epub
+- lib/cbr_to_epub.rb
+- lib/cbr_to_epub/converter.rb
+- lib/cbr_to_epub/file_manager.rb
+- lib/cbr_to_epub/input/cbr_extractor.rb
+- lib/cbr_to_epub/input/cbz_extractor.rb
+- lib/cbr_to_epub/input/extractor_factory.rb
+- lib/cbr_to_epub/output/content/data.rb
+- lib/cbr_to_epub/output/content/metadata.rb
+- lib/cbr_to_epub/output/content/page.rb
+- lib/cbr_to_epub/output/epub_builder.rb
+- lib/cbr_to_epub/output/epub_compressor.rb
+- lib/cbr_to_epub/version.rb
+- lib/template/META-INF/container.xml
+- lib/template/OEBPS/content.opf.erb
+- lib/template/OEBPS/page.xhtml.erb
+- lib/template/OEBPS/style.css
+- lib/template/OEBPS/toc.ncx.erb
+- lib/template/mimetype
+homepage: https://rubygems.org/gems/cbr_to_epub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple gem for converting cbr files to epub
+test_files: []
+has_rdoc: