epuber 0.3.12 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 187fa111e9fda8094a8780e1090e6284264f63bf
-  data.tar.gz: b4ac53c6d3320cc7a3a25a235f9c0296c954458c
+  metadata.gz: 43b004b5cbf151d828970b67bdad742b4199629e
+  data.tar.gz: f763945ec366475789ba83af1945393478beef8f
 SHA512:
-  metadata.gz: 8b0ff50f01876bbbcbafbc2bfb4dce60bf12b7a71c7a41fc72cbfe1d0ca2391a7301a4ef1ae27008af5975fd6268c24aba72189ae16942c2e362dde9ae8fb2bf
-  data.tar.gz: 05179e69736eae612b6f68b9bb06cf3064ef81e8c81f4edd8336994379e6ee8adbeca2021358e1380e74a68158c83e51f73b50bbb1ffb1f67bb6f0f061d38661
+  metadata.gz: f99f327f37f466b5233d32b324b5ff47b71564c64f9a485fb9e4ae0d9070d4be61c23f1860341c5e7cbff0a16715de5d9592b978c786333d63cae6d7d77f11d2
+  data.tar.gz: 95abd127c5d4c38a0fb12deaf728c44893014e36410a119e6b37000e3571fcc78b9268636ae0076fb30d3a6c55d291e7b3175b320fabd63551c07d712c6f924b

data/README.md

@@ -1,6 +1,6 @@
 # Epuber
 
-[![Gem Version](https://badge.fury.io/rb/epuber.svg)](http://badge.fury.io/rb/epuber) [![Build Status](https://travis-ci.org/epuber-io/epuber.svg?branch=master)](https://travis-ci.org/epuber-io/epuber) [![Coverage Status](https://coveralls.io/repos/epuber-io/epuber/badge.svg?branch=master&service=github)](https://coveralls.io/github/epuber-io/epuber?branch=master) [![Inline docs](http://inch-ci.org/github/epuber-io/epuber.svg?branch=master)](http://inch-ci.org/github/epuber-io/epuber)
+[![Gem Version](https://badge.fury.io/rb/epuber.svg)](http://badge.fury.io/rb/epuber) [![Build Status](https://travis-ci.org/epuber-io/epuber.svg?branch=master)](https://travis-ci.org/epuber-io/epuber) [![Coverage Status](https://coveralls.io/repos/epuber-io/epuber/badge.svg?branch=master&service=github)](https://coveralls.io/github/epuber-io/epuber?branch=master) [![Inline docs](http://inch-ci.org/github/epuber-io/epuber.svg?branch=master)](http://inch-ci.org/github/epuber-io/epuber) [![Join the chat at https://gitter.im/epuber-io/epuber](https://badges.gitter.im/epuber-io/epuber.svg)](https://gitter.im/epuber-io/epuber?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 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.
 

data/epuber.gemspec

@@ -12,41 +12,39 @@ Gem::Specification.new do |spec|
   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.homepage = Epuber::HOME_URL
   spec.license  = 'MIT'
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.2'
 
   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 'activesupport', '~> 5.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.6'
   spec.add_runtime_dependency 'mime-types', '~> 3.0'
-  spec.add_runtime_dependency 'claide', '~> 0.8'
+  spec.add_runtime_dependency 'claide', '~> 1.0'
   spec.add_runtime_dependency 'listen', '~> 3.0'
-  spec.add_runtime_dependency 'os', '~> 0.9'
+  spec.add_runtime_dependency 'os', '~> 1.0'
 
-  spec.add_runtime_dependency 'epuber-stylus', '~> 1.0'
-  spec.add_runtime_dependency 'coffee-script', '~> 2.4'
-
-  spec.add_runtime_dependency 'sinatra', '~> 1.4'
+  spec.add_runtime_dependency 'sinatra', '~> 2.0'
   spec.add_runtime_dependency 'sinatra-websocket', '~> 0.3'
-  spec.add_runtime_dependency 'sinatra-contrib', '~> 1.4'
+  spec.add_runtime_dependency 'sinatra-contrib', '~> 2.0'
   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 'epubcheck', '~> 3.0'
 
-  spec.add_runtime_dependency 'bade', '>= 0.1.3', '< 1.0.0'
+  spec.add_runtime_dependency 'epuber-stylus', '~> 1.1.1'
+  spec.add_runtime_dependency 'coffee-script', '~> 2.4'
+  spec.add_runtime_dependency 'bade', '~> 0.2'
 
-  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'rubocop', '~> 0.29'
-  spec.add_development_dependency 'rake', '~> 11'
+  spec.add_development_dependency 'rake', '~> 12.2'
   spec.add_development_dependency 'fakefs', '~> 0.6'
 end

data/lib/epuber/book.rb

@@ -78,7 +78,7 @@ module Epuber
     #
     # @return [Array<Target>]
     #
-    def targets
+    def all_targets
       if @default_target.sub_targets.length == 0
         [@default_target]
       else
@@ -96,6 +96,8 @@ module Epuber
 
     # Defines new target
     #
+    # @param [String, Symbol] name
+    #
     # @return [Target] result target
     #
     def target(name)
@@ -105,6 +107,21 @@ module Epuber
       end
     end
 
+    # Defines several new targets with same configuration
+    #
+    # @param [Array<String, Symbol>] names
+    #
+    # @return [Array<Target>] result target
+    #
+    def targets(*names, &block)
+      if names.empty?
+        UI.warning('Book#targets to get all targets is deprecated, use #all_targets instead', location: caller_locations.first)
+        return all_targets
+      end
+
+      names.map { |name| target(name, &block) }
+    end
+
 
     #-------------- TOC --------------------------------------
 
@@ -197,13 +214,13 @@ module Epuber
     attribute :version,
               inherited:    true,
               types:        [Version],
-              auto_convert: { [String, Fixnum, Float] => Version }
+              auto_convert: { [String, Integer, Float] => Version }
 
     # @return [String] build version of book
     #
     attribute :build_version,
               types:        [Version],
-              auto_convert: { [String, Fixnum, Float] => Version }
+              auto_convert: { [String, Integer, Float] => Version }
 
     # @return [String] base name for output epub file
     #
@@ -242,6 +259,20 @@ module Epuber
       @default_target.add_default_styles(*file_paths)
     end
 
+    # Add default script to default target, default scripts will be automatically added to xhtml document
+    #
+    def add_default_script(*file_paths)
+      @default_target.add_default_script(*file_paths)
+    end
+
+    # Add default scripts to default target, default scripts will be automatically added to xhtml document
+    #
+    def add_default_scripts(*file_paths)
+      @default_target.add_default_scripts(*file_paths)
+    end
+
+    # Method to add plugin, that should be used while building book
+    #
     def use(path)
       @default_target.use(path)
     end
@@ -260,7 +291,7 @@ module Epuber
     def target_named(target_name)
       return target_name if target_name.is_a?(Epuber::Book::Target)
 
-      targets.find do |target|
+      all_targets.find do |target|
         target.name == target_name || target.name.to_s == target_name.to_s
       end
     end

data/lib/epuber/book/target.rb

@@ -24,6 +24,7 @@ module Epuber
         @root_toc  = TocItem.new
 
         @default_styles = []
+        @default_scripts = []
         @plugins = []
       end
 
@@ -35,6 +36,9 @@ module Epuber
         @default_styles.freeze
         @default_styles.each(&:freeze)
 
+        @default_scripts.freeze
+        @default_scripts.each(&:freeze)
+
         @plugins.freeze
         @plugins.each(&:freeze)
 
@@ -96,7 +100,7 @@ module Epuber
       #
       def files
         # parent files plus our files
-        all_files = ((parent && parent.files) || []) + @files + @default_styles
+        all_files = ((parent && parent.files) || []) + @files + @default_styles + @default_scripts
 
         unless @attributes_values[:cover_image].nil?
           all_files << @attributes_values[:cover_image]
@@ -118,6 +122,12 @@ module Epuber
         ((parent && parent.default_styles) || []) + @default_styles
       end
 
+      # @return [Array<Epuber::Book::FileRequest>]
+      #
+      def default_scripts
+        ((parent && parent.default_scripts) || []) + @default_scripts
+      end
+
       # @return [Array<String>]
       #
       def plugins
@@ -134,7 +144,7 @@ module Epuber
                 required:     true,
                 inherited:    true,
                 types:        [Version],
-                auto_convert: { [String, Fixnum, Float] => Version },
+                auto_convert: { [String, Integer, Float] => Version },
                 default_value: 3.0
 
       # @return [String] isbn of epub
@@ -262,6 +272,35 @@ module Epuber
         end
       end
 
+      # @param file_paths [Array<String>]
+      #
+      # @return [void]
+      #
+      def add_default_script(*file_paths)
+        file_paths.map do |file_path|
+          file_obj          = add_file(file_path, group: :script)
+          file_obj.only_one = true
+
+          @default_scripts << file_obj unless @default_scripts.include?(file_obj)
+        end
+      end
+
+      # Add default scripts to target, default scripts will be automatically added to xhtml document
+      #
+      # Only difference with #add_default_script is it adds multiple files with one pattern
+      # @param file_paths [Array<String>]
+      #
+      # @return [void]
+      #
+      def add_default_scripts(*file_paths)
+        file_paths.map do |file_path|
+          file_obj          = add_file(file_path, group: :script)
+          file_obj.only_one = false
+
+          @default_scripts << file_obj unless @default_scripts.include?(file_obj)
+        end
+      end
+
       # @yield [toc_item, target]
       # @yieldparam toc_item [TocItem] root toc item
       # @yieldparam target [self] current target

data/lib/epuber/command.rb

@@ -12,6 +12,7 @@ module Epuber
   end
 
   class Command < CLAide::Command
+    require_relative 'command/build'
     require_relative 'command/compile'
     require_relative 'command/init'
     require_relative 'command/server'
@@ -46,8 +47,12 @@ module Epuber
       UI.current_command = self
     end
 
+    attr_reader :debug_steps_times
+
     protected
 
+    attr_writer :debug_steps_times
+
     # @return [Epuber::Book::Book]
     #
     def book

data/lib/epuber/command/build.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+
+require 'fileutils'
+require 'os'
+
+require_relative '../command'
+
+
+module Epuber
+  class Command
+    class Build < Command
+      require_relative 'compile'
+
+      self.summary = 'Build targets and produces output files.'
+      self.arguments = [
+        CLAide::Argument.new('TARGETS', false, true),
+      ]
+
+      def self.options
+        [
+          ['--check',    'Performs additional validation on sources + checks result epub with epubcheck.'],
+          ['--write',    'Performs additional transformations which writes to source files.'],
+          ['--release',  'Create release version of the book, no caching, everything creates from scratch.'],
+          ['--no-cache', 'Turns off incremental build, can resolve some bugs but build takes much longer.'],
+          ['--debug-steps-times', 'Shows times of each step'],
+        ].concat(super)
+      end
+
+      # @param argv [CLAide::ARGV]
+      #
+      def initialize(argv)
+        @targets_names = argv.arguments!
+        @should_check = argv.flag?('check', false)
+        @should_write = argv.flag?('write', false)
+        @release_version = argv.flag?('release', false)
+        @use_cache = argv.flag?('cache', true)
+
+        self.debug_steps_times = argv.flag?('debug-steps-times', false)
+
+        super(argv)
+      end
+
+      def validate!
+        super
+        verify_one_bookspec_exists!
+        verify_all_targets_exists!
+      end
+
+      def run
+        super
+
+        puts "compiling book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
+
+        if @release_version
+          # Remove all previous versions of compiled files
+          targets.each do |target|
+            build_path = Epuber::Config.instance.release_build_path(target)
+
+            if ::File.directory?(build_path)
+              FileUtils.remove_dir(build_path, true)
+            end
+          end
+
+          # Build all targets to always clean directory
+          targets.each do |target|
+            compiler = Epuber::Compiler.new(book, target)
+            build_path = Epuber::Config.instance.release_build_path(target)
+            compiler.compile(build_path, check: true, write: @should_write,
+                                       release: true, verbose: verbose?,
+                                     use_cache: false)
+
+            archive_name = compiler.epub_name
+
+            if ::File.exists?(archive_name)
+              FileUtils.remove_file(archive_name)
+            end
+
+            archive_path = compiler.archive(archive_name)
+
+            system(%(epubcheck "#{archive_path}"))
+
+            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
+          end
+        else
+          targets.each do |target|
+            compiler = Epuber::Compiler.new(book, target)
+            build_path = Epuber::Config.instance.build_path(target)
+            compiler.compile(build_path, check: @should_check, write: @should_write, verbose: verbose?, use_cache: @use_cache)
+            archive_path = compiler.archive(configuration_suffix: 'debug')
+
+            system(%(epubcheck "#{archive_path}")) if @should_check
+
+            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
+          end
+        end
+
+        write_lockfile
+      end
+
+      private
+
+      # @return [Array<Epuber::Book::Target>]
+      #
+      def targets
+        @targets ||= (
+          targets = @targets_names
+
+          # when the list of targets is nil pick all available targets
+          if targets.empty?
+            book.all_targets
+          else
+            targets.map { |target_name| book.target_named(target_name) }
+          end
+        )
+      end
+
+      def verify_all_targets_exists!
+        index = targets.index(&:nil?)
+        help! "Not found target `#{@targets_names[index]}' in bookspec `#{book.file_path}'" unless index.nil?
+      end
+
+      def validate_dir(path)
+        if ::File.directory?(path)
+          path
+        end
+      end
+
+      def find_calibre_app
+        locations = `mdfind "kMDItemCFBundleIdentifier == net.kovidgoyal.calibre"`.split("\n")
+        UI.error!("Can't find location of calibre.app to convert EPUB to MOBI.") if locations.empty?
+
+        selected = locations.first
+        UI.warning("Found multiple calibre.app, using at location #{selected}") if locations.count > 1
+
+        selected
+      end
+
+      def find_calibre_convert_file
+        if OS.osx?
+          ::File.join(find_calibre_app, 'Contents/MacOS/ebook-convert')
+        elsif OS.linux?
+          script_path = '/usr/bin/ebook-convert'
+          UI.error!("Can't find ebook-convert in folder /usr/bin to convert EPUB to MOBI.") unless ::File.executable?(script_path)
+          script_path
+        else
+          UI.error!('Unsupported OS to convert EPUB to MOBI.')
+        end
+      end
+
+      def convert_epub_to_mobi(epub_path, mobi_path)
+        system(find_calibre_convert_file, epub_path, mobi_path)
+      end
+    end
+  end
+end

data/lib/epuber/command/compile.rb

@@ -1,143 +1,17 @@
 # encoding: utf-8
 
-require 'fileutils'
-require 'os'
-
-require_relative '../command'
-
+require_relative 'build'
 
 module Epuber
   class Command
-    class Compile < Command
-      self.summary = 'Compile targets into multiple EPUB files.'
-      self.arguments = [
-        CLAide::Argument.new('TARGETS', false, true),
-      ]
+    class Compile < Build
+      self.summary = '[Deprecated] Compile targets into multiple EPUB files. Use `build` instead.'
+      Command.inherited(self)
 
-      def self.options
-        [
-          ['--check',   'Performs additional validation on sources + checks result epub with epubcheck.'],
-          ['--write',   'Performs additional transformations which writes to source files.'],
-          ['--release', 'Create release version of the book, no caching, everything creates from scratch.'],
-        ].concat(super)
-      end
-
-      # @param argv [CLAide::ARGV]
-      #
       def initialize(argv)
-        @targets_names = argv.arguments!
-        @should_check = argv.flag?('check', false)
-        @should_write = argv.flag?('write', false)
-        @release_version = argv.flag?('release', false)
-
-        super(argv)
-      end
+        UI.warning('Compile command is now deprecated, please use `build` command instead.')
 
-      def validate!
         super
-        verify_one_bookspec_exists!
-        verify_all_targets_exists!
-      end
-
-      def run
-        super
-
-        puts "compiling book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
-
-        if @release_version
-          # Remove all previous versions of compiled files
-          targets.each do |target|
-            build_path = Epuber::Config.instance.release_build_path(target)
-
-            if ::File.directory?(build_path)
-              FileUtils.remove_dir(build_path, true)
-            end
-          end
-
-          # Build all targets to always clean directory
-          targets.each do |target|
-            compiler = Epuber::Compiler.new(book, target)
-            compiler.compile(Epuber::Config.instance.release_build_path(target), check: true, write: @should_write, release: true, verbose: verbose?)
-
-            archive_name = compiler.epub_name
-
-            if ::File.exists?(archive_name)
-              FileUtils.remove_file(archive_name)
-            end
-
-            archive_path = compiler.archive(archive_name)
-
-            system(%(epubcheck "#{archive_path}"))
-
-            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
-          end
-        else
-          targets.each do |target|
-            compiler = Epuber::Compiler.new(book, target)
-            compiler.compile(Epuber::Config.instance.build_path(target), check: @should_check, write: @should_write, verbose: verbose?)
-            archive_path = compiler.archive(configuration_suffix: 'debug')
-
-            system(%(epubcheck "#{archive_path}")) if @should_check
-
-            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
-          end
-        end
-
-        write_lockfile
-      end
-
-      private
-
-      # @return [Array<Epuber::Book::Target>]
-      #
-      def targets
-        @targets ||= (
-          targets = @targets_names
-
-          # when the list of targets is nil pick all available targets
-          if targets.empty?
-            book.targets
-          else
-            targets.map { |target_name| book.target_named(target_name) }
-          end
-        )
-      end
-
-      def verify_all_targets_exists!
-        index = targets.index(&:nil?)
-        help! "Not found target `#{@targets_names[index]}' in bookspec `#{book.file_path}'" unless index.nil?
-      end
-
-      def validate_dir(path)
-        if ::File.directory?(path)
-          path
-        end
-      end
-
-      def find_calibre_app
-        locations = `mdfind "kMDItemCFBundleIdentifier == net.kovidgoyal.calibre"`.split("\n")
-        UI.error!("Can't find location of calibre.app to convert EPUB to MOBI.") if locations.empty?
-
-        selected = locations.first
-        UI.warn("Using calibre.app at location #{selected}") if locations.count > 1
-
-        selected
-      end
-
-      def find_calibre_convert_file
-        if OS.osx?
-          ::File.join(find_calibre_app, 'Contents/MacOS/ebook-convert')
-        elsif OS.linux?
-          script_path = '/usr/bin/ebook-convert'
-          UI.error!("Can't find ebook-convert in folder /usr/bin to convert EPUB to MOBI.") unless ::File.executable?(script_path)
-          script_path
-        else
-          UI.error!('Unsupported OS to convert EPUB to MOBI.')
-        end
-      end
-
-      def convert_epub_to_mobi(epub_path, mobi_path)
-        system(find_calibre_convert_file, epub_path, mobi_path)
       end
     end
   end