epubber 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6f2cfae818d4167a75a3750def6c2184263f373
-  data.tar.gz: c6d9fe132755c8af4bd234695ffba0606c8cc34f
+  metadata.gz: 1ebe4058b733ff70f76d730d422d3581e9b81fa3
+  data.tar.gz: ab4bf44f7f4b7747f46cb48e78afa63bce32044d
 SHA512:
-  metadata.gz: 9f53c2e01f585f86850c09f92a64038312bde8971fc3b5f45ab278725536e872177153fe4bcc9f0d564fadb43f924026e051544a93292ebf16338682c5c09d07
-  data.tar.gz: bf2bc15b8989e972bb34eacc2bbf7c72eec63db9015a20a4ecad897ac5746e7e5f917a206e9d3652c3215b778fa92ed53b2c959087a160271b642fb35ba16334
+  metadata.gz: 37d018c5a57e2a3fe08a504d2070ff0e54ba2ab1dad98fe84e49a396a8c64bc17e3ca7834addeccfb01591d95c092ad94cf3e4e876094c9fa72c020befcea785
+  data.tar.gz: 34f6c36dec17d26f8fb1fc4a69262c1229cf0f2c4743ab4f012a293817b8d2306762a503bf5cff4e15559af8d098c555b9bc960a755cb243af4e17b23cbbef8e

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/README.md

@@ -26,6 +26,10 @@ path = Epubber.generate do |b|
   b.description 'This is an example EPUB'
   b.url 'http://my-url.com'
 
+  b.cover do |c|
+    c.file File.new('my-image.jpg')
+  end
+
   b.introduction do |i|
     i.content '<p>This is an introduction.</p>'
   end

data/epubber.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry-byebug"
 
   spec.add_runtime_dependency "liquid", "~> 3.0"
   spec.add_runtime_dependency "rubyzip", ">= 1.0.0"

data/lib/epubber/generator.rb

@@ -4,6 +4,7 @@ require 'epubber/generators/toc'
 require 'epubber/generators/introduction'
 require 'epubber/generators/static'
 require 'epubber/generators/endnotes'
+require 'epubber/generators/cover'
 require 'epubber/services/persistance'
 require 'epubber/services/compressor'
 
@@ -22,11 +23,12 @@ class Epubber::Generator
 
   def register_generators(params)
     add_generator Epubber::Generators::Content.new(params)
+    add_generator Epubber::Generators::Cover.new(params)
     add_generator Epubber::Generators::Introduction.new(params)
     add_generator Epubber::Generators::Toc.new(params)
     add_generator Epubber::Generators::Chapters.new(params)
-    add_generator Epubber::Generators::Static.new(params)
     add_generator Epubber::Generators::Endnotes.new(params)
+    add_generator Epubber::Generators::Static.new(params)
   end
 
   def generate

data/lib/epubber/generators/cover.rb

@@ -0,0 +1,15 @@
+require 'epubber/generators/generator'
+
+module Epubber::Generators
+  class Cover < Generator
+    def generate
+      # Because this is an optional generator, don't do anything if there's no
+      # introduction in the book
+      return if book.cover.nil?
+
+      content = template.parse file: 'OEBPS/Text/cover.xhtml', context: book_context
+      persist file: 'OEBPS/Text/cover.xhtml', content: content
+      persist file: "OEBPS/Images/#{book_context['book']['cover']['filename']}", content: book_context['book']['cover']['file']
+    end
+  end
+end

data/lib/epubber/generators/generator.rb

@@ -11,7 +11,7 @@ module Epubber::Generators
   protected
 
     def book_context
-      { 'book' => book.contextify }
+      @book_context ||= { 'book' => book.contextify }
     end
 
     def template

data/lib/epubber/generators/static.rb

@@ -4,7 +4,7 @@ module Epubber::Generators
   class Static < Generator
     def generate
       files = ['mimetype', 'META-INF/container.xml', 'META-INF/com.apple.ibooks.display-options.xml',
-               'OEBPS/Text/cover.xhtml', 'OEBPS/Styles/style.css']
+               'OEBPS/Styles/style.css']
       files.each do |file|
         copy file
       end

data/lib/epubber/models/book.rb

@@ -1,16 +1,17 @@
 require 'securerandom'
-require 'epubber/models/model'
 require 'epubber/models/concerns/has_chapters'
 require 'epubber/models/concerns/has_introduction'
 require 'epubber/models/concerns/has_endnotes'
+require 'epubber/models/concerns/has_cover'
 
 # Represents a book with it's chapters.
 module Epubber::Models
-  class Book < Model
+  class Book
     # Related models and their DSL goodies
     include Epubber::Models::Concerns::HasChapters
     include Epubber::Models::Concerns::HasIntroduction
     include Epubber::Models::Concerns::HasEndnotes
+    include Epubber::Models::Concerns::HasCover
 
     def initialize
       @title        = not_specified
@@ -70,7 +71,9 @@ module Epubber::Models
       context["chapters"]     = contextified_chapters
       context["introduction"] = contextified_introduction
       context["endnotes"]     = contextified_endnotes
-      return context
+      context["cover"]        = contextified_cover
+
+      context
     end
 
   protected

data/lib/epubber/models/chapter.rb

@@ -1,8 +1,10 @@
-require 'epubber/models/model'
+require 'epubber/models/concerns/has_html'
 
 # Represents a book's chapter
 module Epubber::Models
-  class Chapter < Model
+  class Chapter
+    include Epubber::Models::Concerns::HasHTML
+
     def initialize
       @id = 0
       @title = 'Not specified'

data/lib/epubber/models/concerns/has_chapters.rb

@@ -1,23 +1,25 @@
 require 'epubber/models/chapter'
 
-module Epubber::Models::Concerns
-  module HasChapters
-    def chapters
-      @chapters ||= []
-    end
+module Epubber::Models
+  module Concerns
+    module HasChapters
+      def chapters
+        @chapters ||= []
+      end
 
-    # Add chapter
-    def chapter
-      raise 'No block given' unless block_given?
-      chapter = Epubber::Models::Chapter.new
-      yield chapter
-      chapter.id(chapters.count + 1)
-      chapters << chapter
-    end
+      # Add chapter
+      def chapter
+        raise 'No block given' unless block_given?
+        chapter = Epubber::Models::Chapter.new
+        yield chapter
+        chapter.id(chapters.count + 1)
+        chapters << chapter
+      end
 
-    def contextified_chapters
-      chapters.map do |chapter|
-        chapter.contextify
+      def contextified_chapters
+        chapters.map do |chapter|
+          chapter.contextify
+        end
       end
     end
   end

data/lib/epubber/models/concerns/has_cover.rb

@@ -0,0 +1,19 @@
+require 'epubber/models/cover'
+
+module Epubber::Models
+  module Concerns
+    module HasCover
+      def cover(&block)
+        @cover ||= nil
+        return @cover unless block_given?
+        @cover = Epubber::Models::Cover.new
+        yield @cover
+      end
+
+      def contextified_cover
+        return nil if cover.nil?
+        return cover.contextify
+      end
+    end
+  end
+end

data/lib/epubber/models/concerns/has_endnotes.rb

@@ -1,17 +1,19 @@
 require 'epubber/models/endnotes'
 
-module Epubber::Models::Concerns
-  module HasEndnotes
-    def endnotes
-      @endnotes ||= nil
-      return @endnotes unless block_given?
-      @endnotes = Epubber::Models::Endnotes.new
-      yield @endnotes
-    end
+module Epubber::Models
+  module Concerns
+    module HasEndnotes
+      def endnotes
+        @endnotes ||= nil
+        return @endnotes unless block_given?
+        @endnotes = Epubber::Models::Endnotes.new
+        yield @endnotes
+      end
 
-    def contextified_endnotes
-      return nil if endnotes.nil?
-      return endnotes.contextify
+      def contextified_endnotes
+        return nil if endnotes.nil?
+        return endnotes.contextify
+      end
     end
   end
 end

data/lib/epubber/models/concerns/has_html.rb

@@ -0,0 +1,11 @@
+require 'nokogiri'
+
+module Epubber::Models
+  module Concerns
+    module HasHTML
+      def clean_html(html)
+        Nokogiri::HTML::DocumentFragment.parse(html).to_xhtml
+      end
+    end
+  end
+end

data/lib/epubber/models/concerns/has_introduction.rb

@@ -1,17 +1,19 @@
 require 'epubber/models/introduction'
 
-module Epubber::Models::Concerns
-  module HasIntroduction
-    def introduction(&block)
-      @introduction ||= nil
-      return @introduction unless block_given?
-      @introduction = Epubber::Models::Introduction.new
-      yield @introduction
-    end
+module Epubber::Models
+  module Concerns
+    module HasIntroduction
+      def introduction(&block)
+        @introduction ||= nil
+        return @introduction unless block_given?
+        @introduction = Epubber::Models::Introduction.new
+        yield @introduction
+      end
 
-    def contextified_introduction
-      return nil if introduction.nil?
-      return introduction.contextify
+      def contextified_introduction
+        return nil if introduction.nil?
+        return introduction.contextify
+      end
     end
   end
 end

data/lib/epubber/models/cover.rb

@@ -0,0 +1,34 @@
+# Represents a book's introduction
+module Epubber::Models
+  class Cover
+    def initialize
+      @file = nil
+    end
+
+    def file(image = nil)
+      if image
+        @file = image
+      else
+        @file
+      end
+    end
+
+    def filename
+      File.basename(@file.path)
+    end
+
+    def file_mime
+      if /(?:jpg|jpeg)/ =~ filename
+        'image/jpeg'
+      elsif /(?:png)/ =~ filename
+        'image/png'
+      else
+        raise 'Invalid file type: Only JPG and PNG images are allowed.'
+      end
+    end
+
+    def contextify
+      { 'filename' => filename, 'file' => file, 'file_mime' => file_mime }
+    end
+  end
+end

data/lib/epubber/models/endnotes.rb

@@ -1,8 +1,10 @@
-require 'epubber/models/model'
+require 'epubber/models/concerns/has_html'
 
 # Represents a book's introduction
 module Epubber::Models
-  class Endnotes < Model
+  class Endnotes
+    include Epubber::Models::Concerns::HasHTML
+
     def initialize
       @content = '<p>Not specified</p>'
     end

data/lib/epubber/models/introduction.rb

@@ -1,8 +1,10 @@
-require 'epubber/models/model'
+require 'epubber/models/concerns/has_html'
 
 # Represents a book's introduction
 module Epubber::Models
-  class Introduction < Model
+  class Introduction
+    include Epubber::Models::Concerns::HasHTML
+
     def initialize
       @content = '<p>Not specified</p>'
     end

data/lib/epubber/services/persistance.rb

@@ -20,7 +20,11 @@ module Epubber::Services
   protected
 
     def write(file, content)
-      File.write path(file), content
+      if content.is_a?(File)
+        FileUtils.cp content.path, File.dirname(path(file))
+      else
+        File.write path(file), content
+      end
     end
 
     def create_path_for(file)

data/lib/epubber/version.rb

@@ -1,3 +1,3 @@
 module Epubber
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/lib/templates/OEBPS/Text/cover.xhtml

@@ -15,7 +15,7 @@
   </head>
   <body>
     <div id="cover-image">
-      <img alt="[BOOK'S TITLE]" src="../Images/cover.jpg" />
+      <img alt="{{ book.title }}" src="../Images/{{ book.cover.filename }}" />
     </div>
   </body>
 </html>

data/lib/templates/OEBPS/content.opf

@@ -49,7 +49,7 @@
     <!-- Language code: http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes -->
     <dc:language>{{ book.language }}</dc:language>
 
-    <meta name="cover" content="[COVER_NAME].jpg" />
+    <meta name="cover" content="{{ book.cover.filename }}" />
 
     <!-- UUID generator: http://www.famkruithof.net/uuid/uuidgen -->
     <dc:identifier opf:scheme="UUID">urn:uuid:{{ book.uuid }}</dc:identifier>
@@ -64,10 +64,10 @@
   -->
 
   <manifest>
-    <!--
-    <item href="Images/cover.jpg" id="cover.jpg" media-type="image/jpeg" />
-    -->
-    <item href="Text/cover.xhtml" id="cover" media-type="application/xhtml+xml" />
+    {% if book.cover %}
+      <item href="Images/{{ book.cover.filename }}" id="{{ book.cover.filename }}" media-type="{{ book.cover.file_mime }}" />
+      <item href="Text/cover.xhtml" id="cover" media-type="application/xhtml+xml" />
+    {% endif %}
     <item href="toc.ncx" id="ncx" media-type="application/x-dtbncx+xml" />
     <item href="Styles/style.css" id="css" media-type="text/css" />
     <!--
@@ -115,8 +115,10 @@
 
        -->
   <spine toc="ncx">
+    {% if book.cover %}
+      <itemref idref="cover" />
+    {% endif %}
     <!--
-    <itemref idref="cover" />
     <itemref idref="frontmatter" />
     -->
     <itemref idref="toc" />
@@ -152,9 +154,9 @@
 
        -->
   <guide>
-    <!--
-    <reference href="Text/cover.xhtml" title="Cover" type="cover" />
-    -->
+    {% if book.cover %}
+      <reference href="Text/cover.xhtml" title="Cover" type="cover" />
+    {% endif %}
     <reference href="Text/toc.xhtml" title="Table of Contents" type="toc" />
     <!--
     <reference href="Text/frontmatter.xhtml" type="copyright-page" />

data/lib/templates/OEBPS/toc.ncx

@@ -13,13 +13,16 @@
     <text>{{ book.title }}</text>
   </docTitle>
   <navMap>
+    {% if book.cover %}
+      <navPoint id="navpoint-cover">
+        <navLabel>
+          <text>Cover</text>
+        </navLabel>
+        <content src="Text/cover.xhtml" />
+      </navPoint>
+    {% endif %}
+
     <!--
-    <navPoint id="navpoint-cover">
-      <navLabel>
-        <text>Cover</text>
-      </navLabel>
-      <content src="Text/cover.xhtml" />
-    </navPoint>
     <navPoint id="navpoint-frontmatter">
       <navLabel>
         <text>Front Matter</text>

data/test/test_epubber.rb

@@ -1,4 +1,5 @@
 require 'minitest/autorun'
+require 'pry-byebug'
 require 'epubber'
 
 class EpubberTest < Minitest::Test
@@ -7,6 +8,10 @@ class EpubberTest < Minitest::Test
       b.title 'My First EPUB book'
       b.author 'Ramirez, Federico'
 
+      b.cover do |c|
+        c.file File.new("#{File.dirname(__FILE__)}/assets/test-cover.png")
+      end
+
       b.introduction do |i|
         i.content "<p>This is the introduction, and it's optional. What is this book about?</p>"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epubber
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Federico Ramirez
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +125,7 @@ files:
 - lib/epubber/generator.rb
 - lib/epubber/generators/chapters.rb
 - lib/epubber/generators/content.rb
+- lib/epubber/generators/cover.rb
 - lib/epubber/generators/endnotes.rb
 - lib/epubber/generators/generator.rb
 - lib/epubber/generators/introduction.rb
@@ -119,11 +134,13 @@ files:
 - lib/epubber/models/book.rb
 - lib/epubber/models/chapter.rb
 - lib/epubber/models/concerns/has_chapters.rb
+- lib/epubber/models/concerns/has_cover.rb
 - lib/epubber/models/concerns/has_endnotes.rb
+- lib/epubber/models/concerns/has_html.rb
 - lib/epubber/models/concerns/has_introduction.rb
+- lib/epubber/models/cover.rb
 - lib/epubber/models/endnotes.rb
 - lib/epubber/models/introduction.rb
-- lib/epubber/models/model.rb
 - lib/epubber/services/compressor.rb
 - lib/epubber/services/persistance.rb
 - lib/epubber/services/template.rb
@@ -143,6 +160,7 @@ files:
 - lib/templates/OEBPS/content.opf
 - lib/templates/OEBPS/toc.ncx
 - lib/templates/mimetype
+- test/assets/test-cover.png
 - test/test_epubber.rb
 homepage: https://github.com/gosukiwi/epubber
 licenses:
@@ -169,4 +187,5 @@ signing_key:
 specification_version: 4
 summary: Generate EPUB files programatically
 test_files:
+- test/assets/test-cover.png
 - test/test_epubber.rb

data/lib/epubber/models/model.rb

@@ -1,11 +0,0 @@
-require 'nokogiri'
-
-module Epubber::Models
-  class Model
-    # Because the EPUB format always uses XHTML, let's make sure things like
-    # `<br>` gets transformed to `<br />`.
-    def clean_html(html)
-      Nokogiri::HTML::DocumentFragment.parse(html).to_xhtml
-    end
-  end
-end