epuber 0.3.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e871217ca7b9c9c84e676c2fc93b3e06020e5b9e
+  data.tar.gz: 3dda7ef83f00653bfede17172fc5132fb93e1c93
+SHA512:
+  metadata.gz: 05d7c9075a019fc65e02b388cc98ac5aa640d3a42092732894a547fd41406e8d92847ed7dcf2ce491bddea5c376c018b95ef2a6c129e0f75b6af48f950a0d99e
+  data.tar.gz: e4b805811f7d2fba1e1bf143b13eecee70390621198ed871185698b2ee6db571ead5d5f4dba775536c9f0f2e6da4f5d0564acadcdd58105280410a47c93c2421

data/Gemfile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Epuber.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Roman Kříž
+
+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,46 @@
+# Epuber
+
+[![Build Status](https://travis-ci.org/epuber-io/epuber.svg?branch=master)](https://travis-ci.org/epuber-io/epuber)
+
+Epuber is simple tool to compile and pack source files into EPUB format. Offers to define multiple "targets" which allows to create multiple versions of the book by running only one command. Eliminates copying code and information, eliminates needs to use _git_ branches to differ ebook content.
+
+
+## Features
+
+- creating multiple versions of book with requirement to maintain only one source (e.g. for iBooks, Google Play, ...)
+    - defined constants are usable in almost all source files
+- using template engines (currenlty only [Bade](https://github.com/epuber-io/bade)), css preprocessors (currently only Stylus) and standard EPUB formats at the same time
+- have local development server which
+    - automatically refresh web browser when some source file changes
+    - quick jumping to next page with arrow keys on keyboard
+- supports EPUB 2 and 3 + MOBI
+
+
+## Installation
+
+Installation is easy, just type following line to terminal:
+
+    $ gem install epuber
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/samnung/bade. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## TODO
+
+- [ ] move all cards from Trello to GitHub
+- [ ] create documentation 
+- [ ] create several examples of book specification
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/epuber

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby -Ku
+# encoding: utf-8
+
+lib = File.expand_path('../lib', File.dirname(__FILE__))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'epuber'
+
+
+Epuber::Command.run(ARGV)

data/epuber.gemspec

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'epuber/version'
+
+
+Gem::Specification.new do |spec|
+  spec.name     = 'epuber'
+  spec.version  = Epuber::VERSION
+  spec.authors  = ['Roman Kříž']
+  spec.email    = ['samnung@gmail.com']
+  spec.summary  = 'Epuber is simple tool to compile and pack source files into EPUB format.'
+  spec.homepage = 'https://github.com/epuber-io/epuber'
+  spec.license  = 'MIT'
+
+  spec.files         = Dir['bin/**/*'] + Dir['lib/**/*'] + %w(epuber.gemspec Gemfile LICENSE.txt README.md)
+  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_runtime_dependency 'activesupport', '~> 4.2'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+  spec.add_runtime_dependency 'mime-types', '~> 2.4'
+  spec.add_runtime_dependency 'claide', '~> 0.8'
+  spec.add_runtime_dependency 'listen', '~> 3.0'
+  spec.add_runtime_dependency 'os', '~> 0.9'
+
+  spec.add_runtime_dependency 'stylus', '~> 1.0'
+  spec.add_runtime_dependency 'coffee-script', '~> 2.4'
+
+  spec.add_runtime_dependency 'sinatra', '~> 1.4'
+  spec.add_runtime_dependency 'sinatra-websocket', '~> 0.3'
+  spec.add_runtime_dependency 'sinatra-contrib', '~> 1.4'
+  spec.add_runtime_dependency 'thin', '~> 1.6'
+
+  spec.add_runtime_dependency 'rmagick', '~> 2.14'
+
+  spec.add_runtime_dependency 'rubyzip', '~> 1.0'
+
+  spec.add_runtime_dependency 'epubcheck', '~> 3.0', '>= 3.0.1'
+
+  spec.add_runtime_dependency 'bade', '>= 0.1.3', '< 1.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.29'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'fakefs', '~> 0.6'
+end

data/lib/epuber.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Epuber
+  require_relative 'epuber/version'
+
+  require 'bundler/setup'
+
+  autoload :Book, 'epuber/book'
+  autoload :Command, 'epuber/command'
+  autoload :Compiler, 'epuber/compiler'
+  autoload :Config, 'epuber/config'
+  autoload :UI, 'epuber/user_interface'
+  autoload :UserInterface, 'epuber/user_interface'
+end

data/lib/epuber/book.rb

@@ -0,0 +1,267 @@
+# encoding: utf-8
+
+require_relative 'dsl/object'
+
+
+module Epuber
+  class Book < DSL::Object
+    require_relative 'book/contributor'
+    require_relative 'book/target'
+    require_relative 'book/toc_item'
+    require_relative 'book/file_request'
+
+    class StandardError < ::StandardError; end
+
+    def initialize
+      super
+
+      @default_target = Target.new(nil)
+      @toc_blocks     = []
+
+      yield self if block_given?
+    end
+
+    # @return nil
+    #
+    def finish_toc
+      @toc_blocks.each do |block|
+        flat_all_targets.each do |target|
+          target.toc(&block)
+        end
+      end
+    end
+
+    # @return nil
+    #
+    def validate
+      super
+      @default_target.validate
+    end
+
+    # @return nil
+    #
+    def freeze
+      super
+      @default_target.freeze
+    end
+
+    # @return [Epuber::Book::Target]
+    #
+    attr_reader :default_target
+
+
+    # Defines setter and getter for default target attribute
+    #
+    # @param [Symbol] sym  attribute name
+    #
+    # @return [Void]
+    #
+    def self.default_target_attribute(sym, readonly: false)
+      # getter
+      define_method(sym) do
+        @default_target.send(sym)
+      end
+
+      unless readonly
+        # setter
+        setter_method = sym.to_s + '='
+        define_method(setter_method) do |newValue|
+          @default_target.send(setter_method, newValue)
+        end
+      end
+    end
+
+
+    #-------------- Targets ----------------------------------
+
+    # All targets
+    #
+    # @return [Array<Target>]
+    #
+    def targets
+      if @default_target.sub_targets.length == 0
+        [@default_target]
+      else
+        @default_target.sub_targets
+      end
+    end
+
+    def flat_all_targets
+      if @default_target.sub_targets.length == 0
+        [@default_target]
+      else
+        @default_target.flat_sub_items
+      end
+    end
+
+    # Defines new target
+    #
+    # @return [Target] result target
+    #
+    def target(name)
+      @default_target.sub_target(name) do |target|
+        target.book = self
+        yield target if block_given?
+      end
+    end
+
+
+    #-------------- TOC --------------------------------------
+
+    # @return nil
+    #
+    def toc(&block)
+      @toc_blocks << block
+    end
+
+    #------------- DSL attributes ------------------------------------------------------------------------------------
+
+    # @return [String] title of book
+    #
+    attribute :title,
+              required: true
+
+    # @return [String] subtitle of book
+    #
+    attribute :subtitle
+
+    # @return [Array<Contributor>] authors of book
+    #
+    attribute :authors,
+              types:        [Contributor, NormalContributor],
+              container:    Array,
+              required:     true,
+              singularize:  true,
+              auto_convert: { [String, Hash] => ->(value) { Contributor.from_obj(value, 'aut') } }
+
+
+    # @return [String] publisher name
+    #
+    attribute :publisher
+
+    # @return [String] language of this book
+    #
+    attribute :language
+
+    # @return [Bool] book is for iBooks
+    #
+    default_target_attribute :is_ibooks
+
+    # @return [String] isbn of this book
+    #
+    default_target_attribute :isbn
+
+    # @return [String|Fixnum] epub version
+    #
+    default_target_attribute :epub_version
+
+    # @return [Bool] book uses custom fonts (used only for iBooks)
+    #
+    default_target_attribute :custom_fonts
+
+    # @return [Bool] whether the book uses fixed layout
+    #
+    default_target_attribute :fixed_layout
+
+    # @return [String] path or name of cover image
+    #
+    default_target_attribute :cover_image
+
+    # @return [Size] default view port size
+    #
+    default_target_attribute :default_viewport
+
+    # @return [Bool] whether the target should create mobi
+    #
+    default_target_attribute :create_mobi
+
+
+    # @return [String] isbn of printed book
+    #
+    attribute :print_isbn
+
+    # @return [Date] date of book was published
+    #
+    attribute :published,
+              types:        [Date],
+              auto_convert: { String => Date }
+
+
+    # @return [Version] book version
+    # @note Is used only for ibooks versions
+    #
+    attribute :version,
+              inherited:    true,
+              types:        [Version],
+              auto_convert: { [String, Fixnum, Float] => Version }
+
+    # @return [String] build version of book
+    #
+    attribute :build_version,
+              types:        [Version],
+              auto_convert: { [String, Fixnum, Float] => Version }
+
+    # @return [String] base name for output epub file
+    #
+    attribute :output_base_name,
+              inherited: true
+
+
+    # Add file to book, see {Target#add_file} to more details
+    #
+    def add_file(*args)
+      @default_target.add_file(*args)
+    end
+
+    # Add files to book, see Target#add_files to more details
+    #
+    def add_files(*file_paths)
+      @default_target.add_files(*file_paths)
+    end
+
+
+    # Add constant to target, constants can be used within text files
+    #
+    def add_const(*args)
+      @default_target.add_const(*args)
+    end
+
+    # Add default styles to default target, default styles will be automatically added to xhtml document
+    #
+    def add_default_style(*file_paths)
+      @default_target.add_default_style(*file_paths)
+    end
+
+    # Add default styles to default target, default styles will be automatically added to xhtml document
+    #
+    def add_default_styles(*file_paths)
+      @default_target.add_default_styles(*file_paths)
+    end
+
+    def use(path)
+      @default_target.use(path)
+    end
+
+
+
+    # --------------------------------------------------------------------- #
+    # @!group Other methods
+
+    # Finds target with name or nil when not found
+    #
+    # @param target_name [Symbol, String, Epuber::Book::Target]
+    #
+    # @return [Epuber::Book::Target, nil]
+    #
+    def target_named(target_name)
+      return target_name if target_name.is_a?(Epuber::Book::Target)
+
+      targets.find do |target|
+        target.name == target_name || target.name.to_s == target_name.to_s
+      end
+    end
+
+    # TODO: footnotes customization
+    # TODO: custom metadata
+  end
+end

data/lib/epuber/book/contributor.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+module Epuber
+  class Book
+    class Contributor
+      # File-as of contributor used in .opf file
+      # @return [String] pretty name
+      #
+      attr_reader :file_as
+
+      # Pretty name of contributor used in .opf file and copyright page
+      # @return [String] pretty name
+      #
+      attr_reader :pretty_name
+
+      # Role of contributor
+      # @return [String] role
+      #
+      attr_reader :role
+
+
+      # @param [String] pretty_name  pretty name of contributor
+      # @param [String] file_as      file as of contributor
+      # @param [String] role         contributor role
+      #
+      def initialize(pretty_name, file_as, role)
+        @file_as     = file_as
+        @pretty_name = pretty_name
+        @role        = role
+      end
+
+      # Creates new instance of Contributor dependent on obj content
+      #
+      # @param obj [Hash<Symbol, String>, Array<Hash<Symbol,String>, String, Array<String>] input object
+      # @param role [String] role of contributor
+      #
+      # @return [Contributor]
+      #
+      def self.from_obj(obj, role)
+        if obj.is_a?(String)
+          components = obj.split(' ')
+          if components.length >= 2
+            NormalContributor.new(components.first(components.length - 1).join(' '), components.last, role)
+          end
+        elsif obj.is_a?(Hash)
+          if obj.key?(:first_name)
+            NormalContributor.new(obj[:first_name], obj[:last_name], role)
+          elsif obj.key?(:file_as)
+            Contributor.new(obj[:pretty_name], obj[:file_as], role)
+          end
+        end
+      end
+    end
+
+    class NormalContributor < Contributor
+      # @return [String] first name of contributor
+      #
+      attr_accessor :first_name
+
+      # @return [String] last name of contributor
+      #
+      attr_accessor :last_name
+
+
+      # @param [String] first_name first name of contributor
+      # @param [String] last_name last name of contributor
+      # @param [String] role contributor role
+      #
+      def initialize(first_name, last_name, role)
+        super(nil, nil, role)
+
+        @first_name = first_name
+        @last_name  = last_name
+      end
+
+
+      # @return [String]
+      #
+      def pretty_name
+        "#{@first_name} #{@last_name}"
+      end
+
+      # @return [String]
+      #
+      def file_as
+        "#{@last_name.mb_chars.upcase}, #{@first_name}"
+      end
+    end
+  end
+end