softcover 0.0.1 → 0.5.0

data/lib/softcover/commands/deployment_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Softcover::Commands::Deployment do
+
+  describe "default commands" do
+    subject { Softcover::Commands::Deployment.default_commands }
+
+    it { should match /softcover build:all/ }
+    it { should match /softcover build:preview/ }
+    it { should match /softcover publish/ }
+  end
+
+  describe "commands helper" do
+    let(:lines) { ['foo', ' #  bar', 'baz'] }
+    subject { Softcover::Commands::Deployment.commands(lines) }
+
+    it { should match /foo/ }
+    it { should_not match /bar/ }
+    it { should match /baz/ }
+  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!
+        epub = Dir.glob('ebooks/*.epub').first
+        puts "Validating EPUB..."
+        system("#{java} -jar #{epubcheck} #{epub}")
+      end
+
+      private
+
+        def java
+          filename = `which java`.chomp
+          url = 'http://www.java.com/en/download/help/index_installing.xml'
+          message = "Install Java (#{url})"
+          @java ||= executable(filename, message)
+        end
+
+        def epubcheck
+          filename = File.join(Dir.home, 'epubcheck-3.0', 'epubcheck-3.0.jar')
+          url = 'https://code.google.com/p/epubcheck/downloads/' +
+                'detail?name=epubcheck-3.0.zip'
+          message = "Put EpubCheck (#{url}) in your home directory"
+          @epubcheck ||= executable(filename, message).inspect
+        end
+    end
+  end
+end

data/lib/softcover/commands/generator.rb

@@ -0,0 +1,148 @@
+require 'erb'
+module Softcover
+  module Commands
+    module Generator
+      include Softcover::Output
+      extend self
+
+      # Generates the default book file tree.
+      def generate_file_tree(name, options = {})
+        @name = name
+        @markdown = options[:markdown]
+        @simple   = options[:simple]
+
+        thor = Thor::Shell::Basic.new
+
+        puts "Generating directory: #{name}"
+
+        overwrite_all = false
+
+        FileUtils.mkdir name unless File.exist?(name)
+        Dir.chdir name
+
+        # Create the directories.
+        # There was some trouble with MathJax where it was trying to copy a
+        # file before the directory had been created, so we now create all
+        # the directories first.
+        directories.each do |path|
+          next if path =~ /\/simple_book/ && !@simple
+          next if path =~ /\/book/ && @simple
+          (cp_path = path.dup).slice! template_dir + "/"
+          unless File.exist?(cp_path)
+            puts "Creating #{cp_path}" unless cp_path =~ /MathJax/
+            FileUtils.mkdir cp_path
+          end
+        end
+
+        # Create the files.
+        files.each do |path|
+          next if path =~ /\/.$|\/..$/
+
+          (cp_path = path.dup).slice! template_dir + "/"
+
+          if path =~ /book\.tex/
+            cp_path = "#{name}.tex"
+          elsif path =~ /\.erb/
+            cp_path = File.basename path.dup, '.erb'
+          elsif path =~ /gitignore/
+            cp_path = '.gitignore'
+          end
+
+          display_path = File.join name, cp_path
+
+          if File.exist?(cp_path) && !overwrite_all
+            res = thor.ask "#{display_path} already exists. " \
+                           "Overwrite? (yes,no,all):"
+
+            overwrite = case res
+            when /y|yes/ then true
+            when /n|no/  then false
+            when /a|all/ then
+              overwrite_all = true
+              true
+            end
+
+            next unless overwrite
+          end
+
+          puts "Creating #{cp_path}" unless cp_path =~ /MathJax/
+          if path =~ /\.erb/
+            erb = ERB.new(File.read(path)).result(binding)
+            File.open(cp_path, 'w') { |f| f.write erb }
+          else
+            FileUtils.cp path, cp_path
+          end
+        end
+
+        # Symlink the images directory.
+        Dir.chdir "html"
+        FileUtils.rm_f("images") if File.directory?("images")
+        File.symlink("../images", "images")
+
+        Dir.chdir "../.."
+        puts "Done. Please update book.yml"
+      end
+
+      def template_dir
+        File.expand_path File.join File.dirname(__FILE__), "../template"
+      end
+
+      # Returns true for a simple book (no frontmatter, etc.).
+      def simple?
+        @simple
+      end
+
+      # Returns a list of all the files and directories used to build the book.
+      def all_files_and_directories
+        f = files_directories_maybe_markdown
+        simple? ? f.reject { |p| p =~ /\/book\.tex/ || p =~ /preface/ }
+                : f.reject { |p| p =~ /simple/ }
+      end
+
+      # Returns the files and directories based on the input format.
+      def files_directories_maybe_markdown
+        fds = Dir.glob(File.join(template_dir, "**/*"), File::FNM_DOTMATCH)
+        if markdown?
+          # Skip the PolyTeX chapter files, which will be generated later.
+          fds.reject { |e| e =~ /\/chapters\/.*\.tex/ }
+        else
+          # Skip the Markdown files & Book.txt.
+          fds.reject { |e| e =~ /(chapters\/.*\.md|Book\.txt)/ }
+        end
+      end
+
+      # Returns just the directories used for building the book.
+      def directories
+        all_files_and_directories.select { |path| File.directory?(path) }
+      end
+
+      # Returns just the files (not directories) used for building the book.
+      def files
+        all_files_and_directories.reject { |path| File.directory?(path) }
+      end
+
+      def markdown?
+        @markdown
+      end
+
+      def verify!
+        generated_files = Dir.glob("**/*", File::FNM_DOTMATCH).map do |f|
+          File.basename(f)
+        end
+
+        Softcover::Commands::Generator.all_files_and_directories.each do |file|
+          path = if file =~ /book\.tex/
+                   "#{@name}.tex"
+                 elsif file =~ /\.erb/
+                   File.basename(file, '.erb')
+                 elsif file =~ /gitignore/
+                   '.gitignore'
+                 else
+                   File.basename(file)
+                 end
+          raise "missing #{file}" unless generated_files.include?(path)
+        end
+      end
+    end
+  end
+end

data/lib/softcover/commands/opener.rb

@@ -0,0 +1,13 @@
+module Softcover
+  module Commands
+    module Opener
+      extend self
+
+      def open!
+        book = Softcover::Book.new
+        book.open_in_browser
+      end
+
+    end
+  end
+end

data/lib/softcover/commands/publisher.rb

@@ -0,0 +1,106 @@
+module Softcover::Commands::Publisher
+  include Softcover::Utils
+  include Softcover::Output
+
+  extend self
+
+  def publish!(options={})
+    return false unless current_book
+
+    if current_book.create_or_update
+      require 'ruby-progressbar'
+      require 'curb'
+      unless options[:quiet] || options[:silent]
+        puts "Uploading #{current_book.uploader.file_count} files " \
+          "(#{as_size current_book.uploader.total_size}):"
+      end
+      url = current_book.upload!(options)
+      unless options[:quiet] || options[:silent]
+        puts "Published! #{url}"
+      end
+    else
+      puts "Errors: #{current_book.errors}"
+      return false
+    end
+
+    true
+  rescue Softcover::BookManifest::NotFound => e
+    puts e.message
+    false
+  rescue Softcover::Book::UploadError => e
+    puts e.message
+    false
+  end
+
+  # TODO: refactor this flow out of file?
+  def publish_screencasts!(options={})
+    return false unless current_book
+
+    current_book.screencasts_dir = options[:dir] ||
+      Softcover::Book::DEFAULT_SCREENCASTS_DIR
+
+    @watch = options[:watch]
+
+    if options[:daemon]
+      pid = fork do
+        run_publish_screencasts
+      end
+
+      puts "Daemonized, pid: #{pid}"
+    else
+      run_publish_screencasts
+    end
+
+    current_book
+  end
+
+  def run_publish_screencasts
+    if @watch
+      puts "Watching..."
+
+      Signal.trap("TERM") do
+        puts "SIGTERM received."
+        exit_with_message
+      end
+
+      begin
+        loop do
+          process_screencasts
+          sleep 1
+        end
+      rescue Interrupt
+        puts " Interrupt Received."
+        exit_with_message
+      end
+    else
+      process_screencasts
+      exit_with_message
+    end
+  end
+
+  def process_screencasts
+    current_book.process_screencasts
+  end
+
+  def exit_with_message
+    puts "Processed #{current_book.processed_screencasts.size} screencasts."
+  end
+
+  def unpublish!
+    return false unless current_book
+    if current_book.destroy
+      Softcover::BookConfig.remove
+      puts "Done!"
+      return true
+    else
+      puts "Errors: #{current_book.errors}"
+      return false
+    end
+  rescue RestClient::ResourceNotFound
+    puts "Book with ID=#{current_book.id} not found under this account."
+    false
+  rescue Softcover::BookManifest::NotFound => e
+    puts e.message
+    false
+  end
+end

data/lib/softcover/commands/server.rb

@@ -0,0 +1,46 @@
+require 'listen'
+
+module Softcover::Commands::Server
+  include Softcover::Output
+  include Softcover::Utils
+  attr_accessor :no_listener
+  extend self
+
+  # Listens for changes to the book's source files.
+  def listen_for_changes
+    return if defined?(@no_listener) && @no_listener
+    server_pid = Process.pid
+    directories = ['.', 'chapters']
+    @listener = Listen.to(*directories)
+    @listener.filter(/(\.tex|\.md|custom\.sty)$/)
+    @listener.change do |modified|
+      rebuild modified.try(:first)
+      Process.kill("HUP", server_pid)
+    end
+    @listener.start
+  end
+
+  def rebuild(modified=nil)
+    printf modified ? "=> #{File.basename modified} changed, rebuilding... " :
+                      'Building...'
+    t = Time.now
+    Softcover::Builders::Html.new.build
+    puts "Done. (#{(Time.now - t).round(2)}s)"
+
+  rescue Softcover::BookManifest::NotFound => e
+    puts e.message
+  end
+
+  def start_server(port)
+    require 'softcover/server/app'
+    rebuild
+    puts "Running Softcover server on http://localhost:#{port}"
+    Softcover::App.set :port, port
+    Softcover::App.run!
+  end
+
+  def run(port)
+    listen_for_changes
+    start_server port
+  end
+end

data/lib/softcover/config.rb

@@ -0,0 +1,58 @@
+module Softcover
+  class BaseConfig
+
+    DEFAULTS = {
+      host: 'https://www.softcover.io'
+    }
+
+    PATH = '.'
+
+    class << self
+      def [](key)
+        store.transaction do
+          store[key]
+        end || DEFAULTS[key.to_sym]
+      end
+
+      def []=(key, value)
+        store.transaction do
+          store[key] = value
+        end
+      end
+
+      def read
+        puts `cat #{file_path}`
+      end
+
+      def remove
+        File.delete(file_path) if exists?
+      end
+
+      def exists?
+        File.exists?(file_path)
+      end
+
+      protected
+        def store
+          require 'yaml/store'
+          @store ||= begin
+             YAML::Store.new(file_path)
+          end
+        end
+
+        def file_path
+          File.expand_path(self::PATH).tap do |path|
+            path.gsub!(/$/,"-test") if Softcover::test?
+          end
+        end
+    end
+  end
+
+  class BookConfig < BaseConfig
+    PATH = ".softcover-book"
+  end
+
+  class Config < BaseConfig
+    PATH = "~/.softcover"
+  end
+end

data/lib/softcover/formats.rb

@@ -0,0 +1,5 @@
+module Softcover
+  FORMATS = %w{html epub mobi pdf}
+  # mobi calls epub, which calls html, so "all formats" is just mobi & pdf.
+  BUILD_ALL_FORMATS = %w{mobi pdf}
+end

data/lib/softcover/mathjax.rb

@@ -0,0 +1,75 @@
+module Softcover
+  module Mathjax
+
+    # Returns the MathJax configuration.
+    def self.config(options = {})
+      chapter_number = if options[:chapter_number]
+                         options[:chapter_number].inspect.inspect
+                       else
+                         '#{chapter_number}'
+                       end
+      <<-EOS
+      MathJax.Hub.Config({
+        "HTML-CSS": {
+          availableFonts: ["TeX"],
+        },
+        TeX: {
+          extensions: ["AMSmath.js", "AMSsymbols.js"],
+          equationNumbers: {
+            autoNumber: "AMS",
+            formatNumber: function (n) { return #{chapter_number} + '.' + n }
+          },
+          Macros: {
+            PolyTeX:    "Poly{\\\\TeX}",
+            PolyTeXnic: "Poly{\\\\TeX}nic",
+            #{custom_macros}
+          }
+        },
+        showProcessingMessages: false,
+        messageStyle: "none",
+        imageFont: null
+      });
+      EOS
+    end
+
+    # Rerturns a version of the MathJax configuration escaped for the server.
+    # There's an extra interpolation somewhere between here and the server,
+    # which this method corrects for.
+    def self.escaped_config
+      self.config.gsub('\\', '\\\\\\\\')
+    end
+
+    MATHJAX  = 'MathJax/MathJax.js?config='
+    AMS_HTML = '/' + MATHJAX + 'TeX-AMS_HTML'
+    AMS_SVG  = MATHJAX + 'TeX-AMS-MML_SVG'
+
+
+    private
+
+      # Returns the custom macros as defined in the custom style file.
+      def self.custom_macros
+        extract_macros(Softcover.custom_styles)
+      end
+
+      # Extracts and formats the macros from the given string of style commands.
+      # The output format is compatible with the macro configuration described
+      # at http://docs.mathjax.org/en/latest/tex.html.
+      def self.extract_macros(styles)
+        # For some reason, \ensuremath doesn't work in MathJax, so remove it.
+        styles.gsub!('\ensuremath', '')
+        # First extract commands with no arguments.
+        cmd_no_args = /^\s*\\newcommand\{\\(.*?)\}\{(.*)\}/
+        cna = styles.scan(cmd_no_args).map do |name, definition|
+          escaped_definition = definition.gsub('\\', '\\\\\\\\')
+          %(#{name}: "#{escaped_definition}")
+        end
+        # Then grab the commands with arguments.
+        cmd_with_args = /^\s*\\newcommand\{\\(.*?)\}\[(\d+)\]\{(.*)\}/
+        cwa = styles.scan(cmd_with_args).map do |name, number, definition|
+          escaped_definition = definition.gsub('\\', '\\\\\\\\')
+          %(#{name}: ["#{escaped_definition}", #{number}])
+        end
+        (cna + cwa).join(",\n")
+      end
+  end
+end