ebookie 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cbd3543662f1c4abeff2153fae912695093d4c0
+  data.tar.gz: be917c2395058c019bbf02fabfd3da7c6b8ddc19
+SHA512:
+  metadata.gz: 3c5e6c82e1fc905b30cd9aff20300bc98e5d25dfa55b97e6da2ee8d5d4881a25762a3ac5edbddf8e66772568be856be94d0dbc257a3af95f1ad7ede451ee6730
+  data.tar.gz: 8c99693dd10cb8ee9c2eefb69f2f14b2ea5869cf2aec369d821a343ba7b81f28b572745983774e155bbaae22ff59f20c29a919f42d5e6d9000f7d4e1f4903e77

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jordanandree
+
+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.md

@@ -0,0 +1,91 @@
+# Ebookie
+
+Generate PDF, ePub, and Mobi eBooks
+
+[Example project](./example)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ebookie'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ebookie
+
+## Usage
+
+Create a new document:
+
+```ruby
+document = Ebookie::Document.new "My eBook" # Title
+```
+
+Configure it:
+
+```ruby
+document.configure do |config|
+  config.cover        = './path/to/cover.png'  # Cover image
+  config.destination  = './ebook/'             # Ouput for ePub, Mobi, PDF
+  config.subject      = "Introductions"
+  config.source       = "http://google.com"
+end
+```
+
+Add a chapter:
+
+```ruby
+# You can pass a string for the content
+document.chapter 'Getting Started', "All about how to get started"
+
+# You can also give it an html file to read
+document.chapter 'Getting Started', Pathname.new("path/to/myfile.html")
+```
+
+Add an image:
+
+```ruby
+# Relative or absolute path for image to be copied
+document.image './path/to/image.png'
+
+# Chapters can reference images with html:
+document.chapter "My Cool Image", "<img src='image.png' alt='image' />"
+```
+
+Render the document:
+
+```ruby
+# ePub
+document.render_epub
+
+# Mobi
+document.render_mobi
+
+# PDF
+document.render_pdf
+```
+
+#### Install templates for customization:
+
+```bash
+$ ebookie install ./path/to/templatees
+```
+
+Then configure the document:
+
+```ruby
+document.config.template = './path/to/templates'
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/mailchimp/ebookie/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/ebookie.rb

@@ -0,0 +1,16 @@
+module Ebookie
+  require "ebookie/version"
+  require "ebookie/document"
+  require "ebookie/rendering"
+  require "logger"
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+    if ENV['LOG_LEVEL'] && log_level = Logger.const_get(ENV['LOG_LEVEL'])
+      @logger.level = log_level
+    else
+      @logger.level = Logger::WARN
+    end
+    @logger
+  end
+end

data/lib/ebookie/cli.rb

@@ -0,0 +1,20 @@
+require "thor"
+require "pathname"
+
+module Ebookie
+  class Cli < Thor
+    include Thor::Actions
+    add_runtime_options!
+
+    desc "install DIRECTORY", "install template files to DIRECTORY"
+    def install(directory)
+      exec_dir = Pathname.new(Dir.pwd)
+      templates_dir = Pathname.new(File.expand_path('../templates', __FILE__))
+
+      Ebookie::Cli.source_root templates_dir
+
+      directory templates_dir, exec_dir.join(directory)
+    end
+
+  end
+end

data/lib/ebookie/document.rb

@@ -0,0 +1,16 @@
+require "ebookie/document/config"
+require "ebookie/document/base"
+require "ebookie/document/chapter"
+require "ebookie/document/image"
+
+module Ebookie
+  module Document
+    class << self
+
+      def new(*args)
+        Base.new(*args)
+      end
+
+    end
+  end
+end

data/lib/ebookie/document/base.rb

@@ -0,0 +1,49 @@
+module Ebookie
+  module Document
+    class Base
+
+      attr_reader :chapters, :images, :config
+
+      def initialize(title)
+        @chapters = []
+        @images = []
+
+        @config = Config.new
+        @config.title = title
+      end
+
+      def configure(&block)
+        yield @config
+      end
+
+      def chapter(title, content)
+        @chapters << Chapter.new(title, content)
+      end
+
+      def image(file)
+        @images << Image.new(file)
+      end
+
+      def render_pdf
+        Rendering::Pdf.new(self).render
+      end
+
+      def render_epub
+        Rendering::Epub.new(self).render
+      end
+
+      def render_mobi
+        Rendering::Mobi.new(self).render
+      end
+
+      def method_missing(meth, *args)
+        if @config.respond_to?(meth)
+          @config.send(meth, *args)
+        else
+          super
+        end
+      end
+
+    end
+  end
+end

data/lib/ebookie/document/chapter.rb

@@ -0,0 +1,26 @@
+module Ebookie
+  module Document
+    class Chapter
+
+      attr_accessor :title, :content
+
+      def initialize(title, content)
+        @title = title
+        @content = content
+      end
+
+      def content
+        if @content.is_a? Pathname
+          @content.read
+        else
+          @content
+        end
+      end
+
+      def slug
+        title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+      end
+
+    end
+  end
+end

data/lib/ebookie/document/config.rb

@@ -0,0 +1,43 @@
+module Ebookie
+  module Document
+    class Config
+
+      attr_accessor :title
+      attr_accessor :creator
+      attr_accessor :publisher
+      attr_accessor :rights
+      attr_accessor :subject
+      attr_accessor :language
+      attr_accessor :source
+      attr_accessor :date
+      attr_accessor :destination
+      attr_accessor :cover
+      attr_accessor :template
+
+      def date
+        @date || Time.now.strftime("%F")
+      end
+
+      def language
+        @language || "en-US"
+      end
+
+      def cover=(path)
+        if File.exists?(path) || path.match(/http[s]?:\/\//)
+          if %w(.png .pdf).include? File.extname(path)
+            @cover = Pathname.new(path)
+          else
+            Ebookie.logger.warn "Cover file is not a valid"
+          end
+        else
+          Ebookie.logger.warn "Cover file does not exist"
+        end
+      end
+
+      def slug
+        title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+      end
+
+    end
+  end
+end

data/lib/ebookie/document/image.rb

@@ -0,0 +1,29 @@
+module Ebookie
+  module Document
+    class Image
+
+      attr_reader :file
+
+      def initialize(filepath)
+        self.file = filepath
+      end
+
+      def file=(path)
+        if File.exists?(path) || path.match(/http[s]?:\/\//)
+          if File.extname(path) == '.png'
+            @file = Pathname.new(path)
+          else
+            Ebookie.logger.warn "Image file is not a valid png for '#{path}'"
+          end
+        else
+          Ebookie.logger.warn "Image file does not exist for '#{path}'"
+        end
+      end
+
+      def basename
+        File.basename(file) if file
+      end
+
+    end
+  end
+end

data/lib/ebookie/rendering.rb

@@ -0,0 +1,10 @@
+require "ebookie/rendering/base"
+require "ebookie/rendering/epub"
+require "ebookie/rendering/mobi"
+require "ebookie/rendering/pdf"
+
+module Ebookie
+  module Rendering
+
+  end
+end

data/lib/ebookie/rendering/base.rb

@@ -0,0 +1,156 @@
+require "ostruct"
+require "borrower"
+require "erb"
+
+module Ebookie
+  module Rendering
+    class Base
+      IMAGE_SRC_REGEX = /src=['|"]((\/?.+\/)*)?(.+?[\.]+.+?)['|"]/xi
+
+      attr_reader :document
+
+      def initialize(document)
+        @document = document
+
+        after_initialize if respond_to?(:after_initialize)
+      end
+
+      class << self
+        def inherited(subclass)
+          subclass.class_eval do
+            attr_reader :settings
+          end
+
+          subclass.instance_eval do
+            define_method :settings do
+              @@settings.send(format) || {}
+            end
+          end
+        end
+
+        def set(key, val)
+          @@settings ||= OpenStruct.new
+
+          format_options = @@settings.send(format) || {}
+          @@settings.send "#{format}=", format_options.merge({key => val})
+        end
+
+        def format
+          self.name.split("::").last.downcase
+        end
+      end
+
+      def render
+        throw "Output path required" unless document.destination
+
+        FileUtils.mkdir_p(tmp_dir) unless File.exists?(tmp_dir)
+
+        create_paths if settings.keys.include?(:paths) && settings[:paths]
+        copy_files if settings.keys.include?(:files) && settings[:files]
+        copy_images if document.images.any? && settings[:images_dir]
+
+        FileUtils.mkdir_p(document.destination) unless File.exists?(document.destination)
+
+        process!
+        return output_path
+      end
+
+      def template_file(path)
+        custom_template_dir = Pathname.new(document.template) if document.template
+
+        if document.template && File.exists?(custom_template_dir.join(format, path))
+          custom_template_dir.join(format, path)
+        else
+          template_dir.join(path)
+        end
+      end
+
+      def render_erb_to_file(template, filepath, locals={})
+        locals.merge! document: document, renderer: self
+
+        locals_struct = OpenStruct.new(locals).instance_eval { binding }
+        contents = ERB.new(File.read(template)).result(locals_struct)
+
+        write_contents_to_file(contents, filepath)
+      end
+
+      def tmp_dir
+        Pathname.new(File.expand_path("../../../../tmp/#{document.config.slug}/#{format}", __FILE__))
+      end
+
+      def template_dir
+        Pathname.new(File.expand_path("../../templates/#{format}", __FILE__))
+      end
+
+      def format
+        self.class.format
+      end
+
+      def output_path
+        Pathname.new(document.destination).join("#{document.config.slug}.#{format}").to_s
+      end
+
+      def sanitize_html(html)
+        {
+          /&rsquo;|&lsquo;/ => "'",
+          /&rdquo;|&ldquo;|“|”/ => "\"",
+          "’"               => "'",
+          "&#58;"           => ":",
+          "⌘"              => "&#8984;"
+        }.each do |k,v|
+          html.gsub! k, v
+        end
+
+        html
+      end
+
+      def clean_images(html, new_path)
+        html.each_line do |line|
+          old_line = line.dup
+          matches = line.match(IMAGE_SRC_REGEX).to_a
+          next unless matches.any?
+
+          # remove folder
+          line.gsub! matches[2], "" if matches[2]
+
+          # set our folder
+          line.gsub! matches[3], new_path.join(matches[3]).to_s
+
+          html.gsub! old_line, line
+        end
+      end
+
+      private
+
+        def create_paths
+          settings[:paths].each do |path|
+            FileUtils.mkdir_p tmp_dir.join(path)
+          end
+        end
+
+        def copy_images
+          document.images.each do |image|
+            borrow image.file.to_s, to: tmp_dir.join(settings[:images_dir], image.basename)
+          end
+        end
+
+        def copy_files
+          settings[:files].each do |file|
+            if File.extname(file) == '.erb' && ext = File.extname(file)
+              render_erb_to_file template_file(file), tmp_dir.join(file.gsub(ext, ''))
+            else
+              FileUtils.cp template_file(file), tmp_dir.join(file)
+            end
+          end
+        end
+
+        def write_contents_to_file(contents, filepath, mode="w+")
+          File.open(filepath, mode) do |handle|
+            handle.write(contents)
+            handle.close
+          end
+        end
+
+    end
+  end
+end