softcover-nonstop 1.0.beta2

data/lib/softcover/cli.rb

@@ -0,0 +1,270 @@
+require "thor"
+
+module Softcover
+  class CLI < Thor
+    include Softcover::Utils
+
+    map "-v" => :version
+
+    desc "version", "Return the version number (-v for short)"
+    method_option :version, aliases: '-v',
+                            desc: "Print version number", type: :boolean
+    def version
+      require 'softcover/version'
+      puts "Softcover #{Softcover::VERSION}"
+      exit 0
+    end
+
+    # ===============================================
+    # Builder
+    # ===============================================
+
+    desc 'build, build:all', 'Build all formats'
+    method_option :quiet, aliases: '-q',
+                          desc: "Quiet output", type: :boolean
+    method_option :silent, aliases: '-s',
+                           desc: "Silent output", type: :boolean
+    def build
+      Softcover::Commands::Build.all_formats(options)
+    end
+    map "build:all" => "build"
+
+    Softcover::FORMATS.each do |format|
+      desc "build:#{format}", "Build #{format.upcase}"
+      if format == 'pdf'
+        method_option :debug, aliases: '-d',
+                              desc: "Run raw xelatex for debugging purposes",
+                              type: :boolean
+        method_option :once, aliases: '-o',
+                             desc: "Run PDF generator once (no xref update)",
+                             type: :boolean
+        method_option :'find-overfull', aliases: '-f',
+                                        desc: "Find overfull hboxes",
+                                        type: :boolean
+        method_option :nonstop, aliases: '-n',
+                             desc: "Run PDF generator in nonstopmode",
+                             type: :boolean
+      elsif format == 'mobi'
+        method_option :kindlegen, aliases: '-k',
+                                  desc: "Use KindleGen to build the MOBI",
+                                  type: :boolean
+      end
+      method_option :quiet, aliases: '-q',
+                            desc: "Quiet output", type: :boolean
+      method_option :silent, aliases: '-s',
+                             desc: "Silent output", type: :boolean
+      define_method "build:#{format}" do
+        Softcover::Commands::Build.for_format format, options
+      end
+    end
+
+    # ===============================================
+    # Preview
+    # ===============================================
+    desc "build:preview", "Build book preview in all formats"
+    method_option :quiet, aliases: '-q',
+                          desc: "Quiet output", type: :boolean
+    method_option :silent, aliases: '-s',
+                           desc: "Silent output", type: :boolean
+    define_method "build:preview" do
+      Softcover::Commands::Build.preview(options)
+    end
+
+    # ===============================================
+    # Clean
+    # ===============================================
+    desc "clean", "Clean unneeded files"
+    def clean
+      rm(Dir.glob('*.aux'))
+      rm(Dir.glob(File.join('chapters', '*.aux')))
+      rm(Dir.glob('*.toc'))
+      rm(Dir.glob('*.out'))
+      rm(Dir.glob('*.tmp.*'))
+      rm(Dir.glob(path('tmp/*')))
+      rm('.highlight_cache')
+    end
+
+    # ===============================================
+    # Check
+    # ===============================================
+    desc "check", "Check dependencies"
+    def check
+      Softcover::Commands::Check.check_dependencies!
+    end
+
+    # ===============================================
+    # Server
+    # ===============================================
+
+    desc 'server', 'Run local server'
+    method_option :port, type: :numeric, default: 4000, aliases: '-p'
+    def server
+      if Softcover::BookManifest::valid_directory?
+        Softcover::Commands::Server.run options[:port]
+      else
+        puts 'Not in a valid book directory.'
+        exit 1
+      end
+    end
+
+    # ===============================================
+    # Auth
+    # ===============================================
+
+    desc "login", "Log into Softcover account"
+    def login
+      puts "Logging in."
+
+      logged_in = false
+      while not logged_in do
+        email = ask "Email:"
+        password = ask_without_echo "Password (won't be shown):"
+        unless logged_in = Softcover::Commands::Auth.login(email, password)
+          puts "Invalid login, please try again."
+        end
+      end
+      puts "Welcome back, #{email}!"
+    end
+
+    desc "logout", "Log out of Softcover account"
+    def logout
+      Softcover::Commands::Auth.logout
+    end
+
+    # ===============================================
+    # Publisher
+    # ===============================================
+
+    desc "publish", "Publish your book on Softcover"
+    method_option :quiet, aliases: '-q',
+                          desc: "Quiet output", type: :boolean
+    method_option :silent, aliases: '-s',
+                           desc: "Silent output", type: :boolean
+    method_option :remove_unused_media_bundles, aliases: '-r',
+                           desc: "Remove unused media bundles", type: :boolean
+    def publish
+      require 'softcover/commands/publisher'
+
+      invoke :login unless logged_in?
+
+      puts "Publishing..." unless options[:silent]
+      Softcover::Commands::Publisher.publish!(options)
+    end
+
+    desc "publish:media", "Publish media"
+    method_option :daemon, aliases: '-d', force: false,
+      desc: "Run as daemon", type: :boolean
+    method_option :watch, aliases: '-w', type: :boolean,
+      force: false, desc: "Watch a directory to auto upload."
+    method_option :remove_unused_media_files, aliases: '-r',
+                           desc: "Remove unused media files", type: :boolean
+
+    # TODO: make screencasts dir .book configurable
+    define_method "publish:media" do |dir=
+      Softcover::Book::DEFAULT_MEDIA_DIR|
+      require 'softcover/commands/publisher'
+
+      puts "Publishing media bundles..."
+      Softcover::Commands::Publisher.
+        publish_media! options.merge(dir: dir)
+    end
+
+    desc "unpublish", "Remove book from Softcover"
+    method_option :slug, aliases: '-s',
+                          desc: "Specify slug", type: :string
+
+    method_option :force, aliases: '-f',
+                          desc: "Force", type: :boolean
+    def unpublish
+      require 'softcover/commands/publisher'
+
+      invoke :login unless logged_in?
+      slug = options[:slug] || unpublish_slug
+      if options[:force] || ask("Type '#{slug}' to unpublish:") == slug
+        puts "Unpublishing..." unless options[:silent]
+        Softcover::Commands::Publisher.unpublish!(slug)
+      else
+        puts "Canceled."
+      end
+    end
+
+    # ===============================================
+    # Deployment
+    # ===============================================
+    desc "deploy", "Build & publish book"
+    def deploy
+      Softcover::Commands::Deployment.deploy!
+    end
+
+    # ===============================================
+    # Generator
+    # ===============================================
+
+    desc "new <name>", "Generate new book directory structure"
+    method_option :polytex,
+                  :type => :boolean,
+                  :default => false,
+                  :aliases => "-p",
+                  :desc => "Generate a PolyTeX book."
+    def new(n)
+      Softcover::Commands::Generator.generate_file_tree(n, options)
+    end
+
+    # ===============================================
+    # Open
+    # ===============================================
+
+    desc "open", "Open book on Softcover website"
+    def open
+      Softcover::Commands::Opener.open!
+    end
+
+    # ===============================================
+    # EPUB validate
+    # ===============================================
+
+    desc "epub:validate, epub:check", "Validate EPUB with epubcheck"
+    define_method "epub:validate" do
+      Softcover::Commands::EpubValidator.validate!
+    end
+    map "epub:check" => "epub:validate"
+
+    # ===============================================
+    # Config
+    # ===============================================
+
+    desc "config", "View local config"
+    def config
+      require "softcover/config"
+      puts "Reading contents of #{Softcover::Config.path}:"
+      Softcover::Config.read
+    end
+
+    desc "config:add key=value", "Add to your local config vars"
+    define_method "config:add" do |pair|
+      require "softcover/config"
+      key, value = pair.split "="
+      Softcover::Config[key] = value
+
+      puts 'Config var added:'
+      config
+    end
+
+    desc "config:remove key", "Remove key from local config vars"
+    define_method "config:remove" do |key|
+      require "softcover/config"
+      Softcover::Config[key] = nil
+
+      puts 'Config var removed.'
+    end
+
+    protected
+      def ask_without_echo(*args)
+        system "stty -echo"
+        ret = ask *args
+        system "stty echo"
+        puts
+        ret
+      end
+  end
+end

data/lib/softcover/client.rb

@@ -0,0 +1,119 @@
+
+module Softcover
+  class Client
+    include Softcover::Utils
+
+    ApiVersion = 1
+
+    ApiPrefix = "/api/v#{ApiVersion}"
+
+    Paths = {
+      login: 'login',
+      books: 'books'
+    }
+
+    attr_accessor :host, :book
+
+    def initialize(email=nil,password=nil,book=nil)
+      require 'json'
+      require 'rest_client'
+      require "softcover/config"
+      @email = email
+      @password = password
+      @book = book
+
+      @api_key = Softcover::Config['api_key']
+      @host = Softcover::Config['host']
+    end
+
+    def self.new_with_book(book)
+      new nil, nil, book
+    end
+
+    # ============ Auth ===========
+    def login!
+      require "softcover/config"
+      response = post path_for(:login), email: @email, password: @password
+
+      json = JSON response
+      Softcover::Config['api_key'] = @api_key = json['api_key']
+    end
+
+    # ============ Publishing ===========
+    def create_or_update_book(params)
+      JSON post path_for(:books), params
+    rescue RestClient::ResourceNotFound
+      { "errors" =>
+        "Book ID #{params[:id]} not found for this account. "+
+        "Either login again or delete this file: .softcover-book"
+      }
+    end
+
+    def notify_file_upload(params)
+      JSON post path_for(:books, book.id, :notify_file_upload), params
+    end
+
+    def notify_upload_complete
+      JSON put path_for(:books, book.id), upload_complete: true
+    end
+
+    def destroy
+      delete path_for(:books, book.id)
+    end
+
+    def destroy_book_by_slug(slug)
+      delete path_for(:books, slug)
+    end
+
+    # ============ Media ===========
+    def get_media_upload_params(path, files, manifest=nil, options={})
+      JSON post path_for(:books, book.id, :media),
+        path: path,
+        files: files,
+        manifest: manifest,
+        remove_unused_media_files: options[:remove_unused_media_files]
+      # TODO: handle errors
+    end
+
+    # ============ Utils ===========
+    private
+      %w{put post}.each do |verb|
+        define_method verb do |url, params={}, headers={}|
+          begin
+            RestClient.send verb, @host + url,
+              params_with_key(params).to_json,
+              formatted_headers(headers)
+          rescue RestClient::UnprocessableEntity
+            handle_422
+          end
+        end
+      end
+
+      %w{get delete}.each do |verb|
+        define_method verb do |url, headers={}|
+          begin
+            path = "#{@host + url}?api_key=#{@api_key}"
+            RestClient.send verb, path, formatted_headers(headers)
+          rescue RestClient::UnprocessableEntity
+            handle_422
+          end
+        end
+      end
+
+      def params_with_key(params)
+        @api_key.present? ? params.merge({api_key: @api_key}) : params
+      end
+
+      def formatted_headers(headers={})
+        headers.merge accept: :json, content_type: :json
+      end
+
+      def path_for(action, *args)
+        File.join ApiPrefix, Paths[action], *(args.map &:to_s)
+      end
+
+      def handle_422
+        return { "errors" => "You don't have access to that resource." }
+      end
+  end
+end

data/lib/softcover/commands/auth.rb

@@ -0,0 +1,18 @@
+module Softcover
+  module Commands
+    module Auth
+      extend self
+
+      def login(email, password)
+        require "softcover/client"
+        client = Softcover::Client.new email, password
+        client.login!
+      end
+
+      def logout
+        require "softcover/config"
+        Softcover::Config['api_key'] = nil
+      end
+    end
+  end
+end

data/lib/softcover/commands/build.rb

@@ -0,0 +1,74 @@
+module Softcover
+  module Commands
+    module Build
+      include Softcover::Output
+      include Softcover::Utils
+      extend self
+
+      # Builds the book for the given format.
+      def for_format(format, options={})
+        raise 'Invalid format' unless Softcover::FORMATS.include?(format)
+        building_message(format.upcase, options)
+        builder_for(format).build!(options)
+        if format == 'html' && !(options[:silent] || options[:quiet])
+          puts "LaTeX-to-XML debug information output to log/tralics.log"
+        end
+      end
+
+      # Builds the book for all formats.
+      def all_formats(options={})
+        building_message('all formats', options)
+        if custom?
+          build_custom_formats!
+        else
+          Softcover::BUILD_ALL_FORMATS.each do |format|
+            if format == 'mobi'
+              building_message('EPUB & MOBI', options)
+            else
+              building_message(format.upcase, options)
+            end
+            builder_for(format).build!(options)
+          end
+        end
+      end
+
+      # Builds the book preview.
+      def preview(options={})
+        building_message('preview', options)
+        builder_for('preview').build!
+      end
+
+      # Returns the builder for the given format.
+      def builder_for(format)
+        "Softcover::Builders::#{format.titleize}".constantize.new
+      end
+
+      def custom?
+        File.exist?(build_config) && !custom_commands.empty?
+      end
+
+      def build_custom_formats!
+        execute custom_commands
+      end
+
+      # Returns custom commands (if any).
+      def custom_commands
+        commands(File.readlines(build_config).map(&:strip))
+      end
+
+      # Returns the filename for configuring `softcover build`.
+      def build_config
+        '.softcover-build'
+      end
+
+      private
+
+        # Shows a message when building a particular format.
+        def building_message(format, options={})
+          unless options[:silent] || options[:'find-overfull']
+            puts "Building #{format}..."
+          end
+        end
+    end
+  end
+end

data/lib/softcover/commands/check.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+
+module Softcover
+  module Commands
+    module Check
+      extend self
+      extend Softcover::Utils
+
+      def check_dependencies!
+        puts "Checking Softcover dependencies..."
+        simulate_work(1)
+        missing_dependencies = []
+        dependencies.each do |label, name|
+          printf "%-30s", "Checking for #{name}..."
+          simulate_work(0.15)
+          if present?(label)
+            puts "Found"
+          else
+            missing_dependencies << label
+            puts "Missing"
+          end
+          simulate_work(0.1)
+        end
+        simulate_work(0.25)
+        if missing_dependencies.empty?
+          puts "All dependencies satisfied."
+        else
+          puts "Missing dependencies:"
+          missing_dependencies.each do |dependency|
+            puts "  • " + missing_dependency_message(dependency)
+          end
+        end
+      end
+
+      def dependencies
+        [[:latex,       'LaTeX'],
+         [:ghostscript, 'GhostScript'],
+         [:convert,     'ImageMagick'],
+         [:node,        'Node.js'],
+         [:phantomjs,   'PhantomJS'],
+         [:inkscape,    'Inkscape'],
+         [:calibre,     'Calibre'],
+         [:kindlegen,   'KindleGen'],
+         [:java,        'Java'],
+         [:zip,         'zip'],
+         [:epubcheck,   'EpubCheck'],
+        ]
+      end
+
+      def dependency_labels
+        dependencies.map(&:first)
+      end
+
+      def dependency_names
+        dependencies.map { |e| e[1] }
+      end
+
+      def missing_dependency_message(label)
+        case label
+        when :latex
+          message  = "LaTeX (http://latex-project.org/ftp.html)\n"
+          message += "      ∟ Huge download—start it now!"
+        when :ghostscript
+          message  = "GhostScript (should come with LaTeX)\n"
+        when :convert
+          "ImageMagick (http://www.imagemagick.org/script/binary-releases.php)"
+        when :node
+          "NodeJS (http://nodejs.org/)"
+        when :phantomjs
+          message = "PhantomJS (http://phantomjs.org/)\n"
+          message += "      ∟ Put bin/phantomjs somewhere on your path,"
+          message += " e.g., in /usr/local/bin"
+        when :kindlegen
+          url = 'http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211'
+          message = "KindleGen (#{url})\n"
+          message += "      ∟ Put the kindlegen executable on your path,"
+          message += " e.g., in /usr/local/bin"
+        when :calibre
+          url = 'http://calibre-ebook.com/'
+          message  = "Calibre (#{url})\n"
+          message += "      ∟ Enable Calibre command-line tools"
+          message += " (http://manual.calibre-ebook.com/cli/cli-index.html)"
+        when :java
+          url = 'http://www.java.com/en/download/help/index_installing.xml'
+          "Java (#{url})"
+        when :zip
+          "Install zip (e.g., apt-get install zip)"
+        when :epubcheck
+          url  = 'https://github.com/IDPF/epubcheck/releases/'
+          url += 'download/v3.0/epubcheck-3.0.zip'
+          message  = "EpubCheck 3.0 (#{url})\n"
+          message += "      ∟ Unzip and put epubcheck-3.0/ in $HOME/bin"
+        when :inkscape
+          message  = "Inkscape (http://inkscape.org/)"
+        else
+          raise "Unknown label #{label}"
+        end
+      end
+
+      def present?(label)
+        File.exist?(dependency_filename(label))
+      end
+
+      # Simulate working for given time.
+      # `softcover check` is more satisfying if it looks like it's doing work.
+      def simulate_work(time)
+        sleep time unless Softcover::test?
+      end
+
+    end
+  end
+end

data/lib/softcover/commands/deployment.rb

@@ -0,0 +1,35 @@
+module Softcover
+  module Commands
+    module Deployment
+      include Softcover::Utils
+      extend self
+
+      # Deploy a book by building and publishing it.
+      # The deploy steps can be customized using `.poly-publish`
+      # in the book project's home directory.
+      def deploy!
+        if File.exist?('.softcover-deploy') && !custom_commands.empty?
+          execute custom_commands
+        else
+          execute default_commands
+        end
+      end
+
+      # Returns the default commands.
+      def default_commands
+        commands(['softcover build:all', 'softcover build:preview',
+                  'softcover publish'])
+      end
+
+      # Returns custom commands (if any).
+      def custom_commands
+        commands(File.readlines(deploy_config).map(&:strip))
+      end
+
+      # Returns the filename for configuring `softcover deploy`.
+      def deploy_config
+        '.softcover-deploy'
+      end
+    end
+  end
+end

data/lib/softcover/commands/epub_validator.rb

@@ -0,0 +1,32 @@
+module Softcover
+  module Commands
+    module EpubValidator
+      extend Softcover::Utils
+      extend self
+
+      # Validates a book according to the EPUB standard.
+      def validate!
+        manifest = BookManifest.new(source: source)
+        epub = path("ebooks/#{manifest.filename}.epub")
+        if File.exist?(epub)
+          puts "Validating EPUB..."
+          system("#{java} -jar #{epubcheck} #{epub}")
+        else
+          puts "File '#{epub}' not found"
+          puts "Run 'softcover build:epub' to generate"
+          exit 1
+        end
+      end
+
+      private
+
+        def java
+          @java ||= executable(dependency_filename(:java))
+        end
+
+        def epubcheck
+          @epubcheck ||= executable(dependency_filename(:epubcheck)).inspect
+        end
+    end
+  end
+end