softcover 0.7.11 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0c89273e495d59b500f34a6c72f3994fdcd5437
-  data.tar.gz: 7ccaefc71bd47fa7bb2e413ec9237887a0c870a8
+  metadata.gz: 4e55cdffedc838f8932586db5eff983d9a84dd4b
+  data.tar.gz: fc341b0355f009345ef895b9d57a24ed9a651412
 SHA512:
-  metadata.gz: c4ca22081fa2754e8e12af46337de659db136084eda0ab6888ce9a099c1125348b3e2778101a88bbaef725ff7f125d5a2dda5f7e05e834011c8d3ac75c1c8b2a
-  data.tar.gz: f3b9d3238f4b902c8274cf44b868b029da36db2c30311eb7059f069af9b38fa9d9d9be75230a8f90dea822b74d5a6d2507bee4ac89f6c449d635faa9365f31f6
+  metadata.gz: 050cf03897d867223e98e3ff8b49b1efffb4984e7241a5bcd73cc53b0171fc50ea5de1ab3481ed546c53054f7a677146201f8a30e62ab69752af13addb846256
+  data.tar.gz: a81b24fe60937288477896740a7bd5eb11b9dc50aed52728d771bdfedde29d013410fda4944c42784632dd6e13dd45324d1734793721cbea7bfa5f5731ece8be

data/Gemfile

@@ -8,6 +8,7 @@ group :test do
   gem 'webmock',   require: false
   gem 'simplecov', require: false
   gem 'rack-test'
+  gem 'ruby-prof'
 end
 
 group :development do

data/lib/softcover.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/string'
 require_relative 'softcover/formats'
 require_relative 'softcover/utils'
 require_relative 'softcover/output'
+require_relative 'softcover/directories'
 
 profile = false
 if profile
@@ -41,7 +42,7 @@ module Softcover
 
   # Return the custom styles, if any.
   def custom_styles
-    custom_file = 'custom.sty'
+    custom_file = File.join(Softcover::Directories::STYLES, 'custom.sty')
     File.exist?(custom_file) ? File.read(custom_file) : ''
   end
 

data/lib/softcover/book.rb

@@ -11,6 +11,8 @@ class Softcover::Book
   def initialize(options={})
     require "softcover/client"
     @manifest = Softcover::BookManifest.new(options)
+    @marketing = Softcover::MarketingManifest.new
+
     @client = Softcover::Client.new_with_book self
 
     @screencasts_dir = DEFAULT_SCREENCASTS_DIR
@@ -101,8 +103,11 @@ class Softcover::Book
                                         slug: slug,
                                         subtitle: subtitle,
                                         description: description,
-                                        cover: cover,
-                                        chapters: chapter_attributes
+                                        chapters: chapter_attributes,
+                                        prices: prices,
+                                        faq: faq,
+                                        testimonials: testimonials,
+                                        marketing_content: marketing_content
 
     if res['errors']
       @errors = res['errors']
@@ -166,7 +171,7 @@ class Softcover::Book
     files_to_upload = find_screencasts.select do |file|
       next false if @processed_screencasts.include?(file)
 
-      file.ready?# && upload_screencast!(file)
+      file.ready?
     end
 
     upload_screencasts! files_to_upload
@@ -174,8 +179,13 @@ class Softcover::Book
     @processed_screencasts += files_to_upload
   end
 
+  SCREENCAST_FORMATS = %w{mov ogv mp4 webm}
+
   def find_screencasts
-    Dir["#{@screencasts_dir}/**/*.mov"].map{ |path| BookFile.new path }
+    formats = SCREENCAST_FORMATS * ','
+    Dir["#{@screencasts_dir}/**/*.{#{formats},zip}"].map do |path|
+      BookFile.new path
+    end
   end
 
   def upload_screencasts!(files)
@@ -196,6 +206,6 @@ class Softcover::Book
 
   private
     def method_missing(name, *args, &block)
-      @manifest.send(name) || super
+      @manifest.send(name) || @marketing.send(name) || super
     end
 end

data/lib/softcover/book_manifest.rb

@@ -3,6 +3,23 @@ require 'ostruct'
 class Softcover::BookManifest < OpenStruct
   include Softcover::Utils
 
+  class Softcover::MarketingManifest < Softcover::BookManifest
+
+    YAML_PATH = File.join(Softcover::Directories::CONFIG, 'marketing.yml')
+    def initialize
+      ensure_marketing_file
+      marshal_load read_from_yml.symbolize_keys!
+    end
+
+    # Ensures the existence of 'marketing.yml'.
+    # We copy from the template if necessary.
+    def ensure_marketing_file
+      template = File.join(File.dirname(__FILE__), 'template', YAML_PATH)
+      FileUtils.cp(template, YAML_PATH) unless File.exist?(YAML_PATH)
+    end
+  end
+
+
   class NotFound < StandardError
     def message
       "Invalid book directory, no manifest file found!"
@@ -10,9 +27,7 @@ class Softcover::BookManifest < OpenStruct
   end
 
   class Chapter < OpenStruct
-    def path
-      File.join('chapters', slug + '.tex')
-    end
+    include Softcover::Utils
 
     def fragment_name
       "#{slug}_fragment.html"
@@ -49,13 +64,20 @@ class Softcover::BookManifest < OpenStruct
     def full_name
       "#{slug}#{extension}"
     end
+
+    # Returns the name for the cached version of the chapters.
+    # This is used when processing Markdown to avoid unnecessary calls to
+    # kramdown's to_latex method, which can get expensive.
+    def cache_filename
+      Softcover::Utils.path("tmp/#{full_name}.cache")
+    end
   end
 
   class Section < OpenStruct
   end
 
   TXT_PATH  = 'Book.txt'
-  YAML_PATH = "book.yml"
+  YAML_PATH = File.join(Softcover::Directories::CONFIG, 'book.yml')
 
   def initialize(options = {})
     @source = options[:source] || :polytex
@@ -225,6 +247,11 @@ class Softcover::BookManifest < OpenStruct
   end
 
   def self.valid_directory?
+    # Needed for backwards compatibility
+    if File.exist?('book.yml') && !Dir.pwd.include?('config')
+      Softcover::Utils.mkdir('config')
+      FileUtils.mv('book.yml', 'config')
+    end
     [YAML_PATH, TXT_PATH].any? { |f| File.exist?(f) }
   end
 
@@ -274,7 +301,19 @@ class Softcover::BookManifest < OpenStruct
       require 'softcover/config'
       require 'yaml/store'
       self.class.find_book_root!
-      YAML.load_file(YAML_PATH)
+      ensure_book_yml
+      YAML.load_file(self.class::YAML_PATH)
+    end
+
+    # Ensures that the book.yml file is in the right directory.
+    # This is for backwards compatibility.
+    def ensure_book_yml
+      path = self.class::YAML_PATH
+      unless File.exist?(path)
+        base = File.basename(path)
+        Softcover::Utils.mkdir Softcover::Directories::CONFIG
+        FileUtils.mv base, Softcover::Directories::CONFIG
+      end
     end
 
 

data/lib/softcover/builder.rb

@@ -8,6 +8,7 @@ module Softcover
       @manifest = Softcover::BookManifest.new(verify_paths: true,
                                               source: source)
       @built_files = []
+      ensure_style_file_locations
       write_polytexnic_commands_file
     end
 
@@ -24,9 +25,34 @@ module Softcover
       def setup; end
       def verify; end
 
+      # Ensures the style files are in the right location.
+      # This is for backwards compatibility.
+      def ensure_style_file_locations
+        styles_dir = Softcover::Directories::STYLES
+        mkdir styles_dir
+        fix_custom_include
+        files = Dir.glob('*.sty')
+        FileUtils.mv(files, styles_dir)
+      end
+
+      # Fixes the custom include.
+      # The template includes the custom style file as an example
+      # of file inclusion. Unfortunately, the location of 'custom.sty', has
+      # changed, which will result in older templates spontaneously breaking.
+      def fix_custom_include
+        first_chapter = File.join('chapters', 'a_chapter.tex')
+        if File.exist?(first_chapter)
+          text = File.read(first_chapter)
+          text.gsub!('<<(custom.sty',
+                     "<<(#{Softcover::Directories::STYLES}/custom.sty" )
+          File.write(first_chapter, text)
+        end
+      end
+
       # Writes out the PolyTeXnic commands from polytexnic.
       def write_polytexnic_commands_file
-        Polytexnic.write_polytexnic_style_file(Dir.pwd)
+        styles_dir = File.join(Dir.pwd, Softcover::Directories::STYLES)
+        Polytexnic.write_polytexnic_style_file(styles_dir)
       end
   end
 end

data/lib/softcover/builders/epub.rb

@@ -5,7 +5,7 @@ module Softcover
 
       def build!(options={})
         @preview = options[:preview]
-        Softcover::Builders::Html.new.build!(preserve_tex: true)
+        Softcover::Builders::Html.new.build!
         if manifest.markdown?
           self.manifest = Softcover::BookManifest.new(source: :polytex,
                                                       origin: :markdown)
@@ -32,7 +32,7 @@ module Softcover
       # Removes HTML.
       # All the HTML is generated, so this clears out any unused files.
       def remove_html
-        FileUtils.rm(Dir.glob(path('epub/OEBPS/html/*.html')))
+        FileUtils.rm(Dir.glob(path('epub/OEBPS/*.html')))
       end
 
       def create_directories
@@ -218,17 +218,24 @@ module Softcover
         epub_styles = File.join('epub', 'OEBPS', 'styles')
 
         FileUtils.cp(File.join(html_styles, 'pygments.css'), epub_styles)
+        File.write(File.join(epub_styles, 'softcover.css'),
+                   clean_book_id(path("#{html_styles}/softcover.css")))
 
         # Copy over the EPUB-specific CSS.
         template_dir = File.join(File.dirname(__FILE__), '..', 'template')
-        epub_css = File.join(template_dir, epub_styles, 'epub.css')
+        epub_css     = File.join(template_dir, epub_styles, 'epub.css')
         FileUtils.cp(epub_css, epub_styles)
 
-        # For some reason, EPUB books hate the #book ids in the stylesheet
-        # (i.e., such books fail to validate), so remove them.
-        polytexnic_css = File.read(File.join(html_styles, 'softcover.css'))
-        polytexnic_css.gsub!(/\s*#book\s+/, '')
-        File.write(File.join(epub_styles, 'softcover.css'), polytexnic_css)
+        # Copy over custom CSS.
+        File.write(File.join(epub_styles, 'custom.css'),
+                   clean_book_id(path("#{html_styles}/custom.css")))
+      end
+
+      # Removes the '#book' CSS id.
+      # For some reason, EPUB books hate the #book ids in the stylesheet
+      # (i.e., such books fail to validate), so remove them.
+      def clean_book_id(filename)
+        File.read(filename).gsub(/#book/, '')
       end
 
       # Copies the image files from the HTML version of the document.
@@ -334,6 +341,7 @@ module Softcover
         <item id="pygments.css" href="styles/pygments.css" media-type="text/css"/>
         <item id="softcover.css" href="styles/softcover.css" media-type="text/css"/>
         <item id="epub.css" href="styles/epub.css" media-type="text/css"/>
+        <item id="custom.css" href="styles/custom.css" media-type="text/css"/>
         <item id="cover" href="cover.html" media-type="application/xhtml+xml"/>
         #{man_ch.join("\n")}
         #{images.join("\n")}
@@ -431,6 +439,7 @@ module Softcover
           <link rel="stylesheet" href="styles/pygments.css" type="text/css" />
           <link rel="stylesheet" href="styles/softcover.css" type="text/css" />
           <link rel="stylesheet" href="styles/epub.css" type="text/css" />
+          <link rel="stylesheet" href="styles/custom.css" type="text/css"/>
           <link rel="stylesheet" type="application/vnd.adobe-page-template+xml" href="styles/page-template.xpgt" />
         </head>
 

data/lib/softcover/builders/html.rb

@@ -7,9 +7,14 @@ module Softcover
 
       def setup
         Dir.mkdir "html" unless File.directory?("html")
-        unless File.directory?(path('html/stylesheets'))
-          Dir.mkdir path('html/stylesheets')
+        html_styles = path('html/stylesheets')
+        unless File.directory?(html_styles)
+          Dir.mkdir html_styles
         end
+        template_dir = path("#{File.dirname(__FILE__)}/../template")
+        custom_css = path("#{template_dir}/html/stylesheets/custom.css")
+        target = path("#{html_styles}/custom.css")
+        FileUtils.cp(custom_css, target) unless File.exist?(target)
         clean!
       end
 
@@ -23,7 +28,7 @@ module Softcover
 
         if manifest.markdown?
           unless options[:'find-overfull']
-            FileUtils.rm(Dir.glob(path("#{manifest.polytex_dir}/*.tex")))
+            remove_unneeded_polytex_files
           end
           manifest.chapters.each do |chapter|
             write_latex_files(chapter, options)
@@ -40,7 +45,8 @@ module Softcover
           @html  = converted_html(basename)
           @title = basename
           erb_file = File.read(File.join(File.dirname(__FILE__),
-                                         '../server/views/book.html.erb'))
+                                         '..', 'server', 'views',
+                                         'book.html.erb'))
           file_content = ERB.new(erb_file).result(binding)
           write_full_html_file(basename, file_content)
           write_chapter_html_files(Nokogiri::HTML(file_content), erb_file)
@@ -55,20 +61,48 @@ module Softcover
         true
       end
 
+      # Removes any PolyTeX files not corresponding to current MD chapters.
+      def remove_unneeded_polytex_files
+        files_to_keep = manifest.chapters.map do |chapter|
+                          path("#{manifest.polytex_dir}/#{chapter.slug}.tex")
+                        end
+        all_files = Dir.glob(path("#{manifest.polytex_dir}/*.tex"))
+        files_to_remove = all_files - files_to_keep
+        FileUtils.rm(files_to_remove)
+      end
+
       # Writes the LaTeX files for a given Markdown chapter.
       def write_latex_files(chapter, options = {})
-        filename = path("#{manifest.polytex_dir}/#{chapter.slug}.tex")
+        polytex_filename = path("#{manifest.polytex_dir}/#{chapter.slug}.tex")
         if chapter.source == :polytex
-          FileUtils.cp path("chapters/#{chapter.full_name}"), filename
+          FileUtils.cp path("chapters/#{chapter.full_name}"), polytex_filename
         else
-          path = File.join('chapters', chapter.full_name)
-          cc = Softcover.custom_styles
-          md = Polytexnic::Pipeline.new(File.read(path), source: :markdown,
-                                                         custom_commands: cc)
-          File.write(filename, md.polytex)
+          mkdir Softcover::Directories::TMP
+          markdown = File.read(path("chapters/#{chapter.full_name}"))
+          # Only write if the Markdown file hasn't changed since the last time
+          # it was converted, as then the current PolyTeX file is up-to-date.
+          # The call to File.exist?(filename) is just in case the PolyTeX file
+          # corresponding to the Markdown file was removed by hand in the
+          # interim.
+          unless (File.exist?(chapter.cache_filename) &&
+                  File.read(chapter.cache_filename) == digest(markdown) &&
+                  File.exist?(polytex_filename))
+            File.write(polytex_filename, polytex(chapter, markdown))
+          end
         end
       end
 
+      # Returns the PolyTeX for the chapter.
+      # As a side-effect, we cache a digest of the Markdown to prevent
+      # unnecessary conversions.
+      def polytex(chapter, markdown)
+        File.write(chapter.cache_filename, digest(markdown))
+        p = Polytexnic::Pipeline.new(markdown,
+                                     source: :markdown,
+                                     custom_commands: Softcover.custom_styles)
+        p.polytex
+      end
+
       # Returns the converted HTML.
       def converted_html(basename)
         polytex_filename = basename + '.tex'
@@ -152,7 +186,12 @@ module Softcover
             target = target_cache[ref_id]
             unless target.nil?
               id = target['id']
-              ref_chapter = ref_map[target['data-tralics-id']]
+              ref_chapter = if target['data-tralics-id'].nil?
+                              # This branch is true for chapter-star.
+                              chapter
+                            else
+                              ref_map[target['data-tralics-id']]
+                            end
               ref_node['href'] = "#{ref_chapter.fragment_name}##{id}"
             end
           end

data/lib/softcover/builders/pdf.rb

@@ -28,18 +28,16 @@ module Softcover
 
         polytex_filenames = manifest.pdf_chapter_filenames << book_filename
         polytex_filenames.each do |filename|
-          polytex = File.open(filename) { |f| f.read }
+          polytex = File.read(filename)
           latex   = Polytexnic::Pipeline.new(polytex).to_latex
           if filename == book_filename
             latex.gsub!(/\\include{(.*?)}/) do
               "\\include{#{Softcover::Utils.tmpify(manifest, $1)}.tmp}"
             end
           end
-          File.open(Softcover::Utils.tmpify(manifest, filename), 'w') do |f|
-            f.write(latex)
-          end
+          File.write(Softcover::Utils.tmpify(manifest, filename), latex)
         end
-        write_pygments_file(:latex)
+        write_pygments_file(:latex, Softcover::Directories::STYLES)
         copy_polytexnic_sty
 
         # Renaming the PDF in the command is necessary because `execute`
@@ -48,7 +46,8 @@ module Softcover
         # is ignored.
         # (The reason for using `exec` is so that LaTeX errors get emitted to
         # the screen rather than just hanging the process.)
-        cmd = "#{pdf_cmd(book_filename, options)} ; #{rename_pdf(basename)}"
+        cmd = "#{pdf_cmd(book_filename, options)} " +
+              "; #{rename_pdf(basename, options)}"
         # Here we use `system` when making a preview because the preview command
         # needs to run after the main PDF build.
         if options[:quiet] || options[:silent]
@@ -106,19 +105,22 @@ module Softcover
         # The purpose is to match the original filename.
         # For example, foo_bar.tex should produce foo_bar.pdf.
         # While we're at it, we move it to the standard ebooks/ directory.
-        def rename_pdf(basename)
+        def rename_pdf(basename, options={})
           tmp_pdf = basename + '.tmp.pdf'
           pdf     = basename + '.pdf'
           mkdir('ebooks')
-          "mv -f #{tmp_pdf} #{File.join('ebooks', pdf)}"
+          # Remove the intermediate tmp files unless only running once.
+          rm_tmp = options[:once] || Softcover.test? ? "" : "&& rm -f *.tmp.*"
+          "mv -f #{tmp_pdf} #{File.join('ebooks', pdf)} #{rm_tmp}"
         end
 
-        # Copies the PolyTeXnic style file to ensure it's always fresh.
+        # Copies the style file to ensure it's always fresh.
         def copy_polytexnic_sty
-          polytexnic_sty = 'softcover.sty'
+          softcover_sty  = File.join(Softcover::Directories::STYLES,
+                                     'softcover.sty')
           source_sty     = File.join(File.dirname(__FILE__),
-                                     "../template/#{polytexnic_sty}")
-          FileUtils.cp source_sty, polytexnic_sty
+                                     '..', 'template', softcover_sty)
+          FileUtils.cp source_sty, softcover_sty
         end
     end
   end

data/lib/softcover/cli.rb

@@ -133,6 +133,7 @@ module Softcover
     # TODO: make screencasts dir .book configurable
     define_method "publish:screencasts" do |dir=
       Softcover::Book::DEFAULT_SCREENCASTS_DIR|
+      require 'softcover/commands/publisher'
 
       puts "Publishing screencasts in #{dir}"
       Softcover::Commands::Publisher.

data/lib/softcover/commands/generator.rb

@@ -40,7 +40,8 @@ module Softcover
           if path =~ /book\.tex/
             cp_path = "#{name}.tex"
           elsif path =~ /\.erb/
-            cp_path = File.basename path.dup, '.erb'
+            cp_path = File.join(File.dirname(cp_path),
+                                File.basename(path.dup, '.erb'))
           elsif path =~ /gitignore/
             cp_path = '.gitignore'
           end
@@ -77,11 +78,12 @@ module Softcover
         File.symlink("../images", "images")
 
         Dir.chdir "../.."
-        puts "Done. Please update book.yml"
+        book_yml = File.join(Softcover::Directories::CONFIG, 'book')
+        puts "Done. Please update #{book_yml}"
       end
 
       def template_dir
-        File.expand_path File.join File.dirname(__FILE__), "../template"
+        File.expand_path File.join File.dirname(__FILE__), "..", "template"
       end
 
       # Returns a list of all the files and directories used to build the book.

data/lib/softcover/commands/publisher.rb

@@ -36,6 +36,9 @@ module Softcover::Commands::Publisher
   def publish_screencasts!(options={})
     return false unless current_book
 
+    require 'ruby-progressbar'
+    require 'curb'
+
     current_book.screencasts_dir = options[:dir] ||
                                    Softcover::Book::DEFAULT_SCREENCASTS_DIR
 

data/lib/softcover/commands/server.rb

@@ -10,7 +10,7 @@ module Softcover::Commands::Server
   def listen_for_changes
     return if defined?(@no_listener) && @no_listener
     server_pid = Process.pid
-    filter_regex = /(\.md|\.tex|custom\.sty|Book\.txt|book\.yml)$/
+    filter_regex = /(\.md|\.tex|custom\.sty|custom\.css|Book\.txt|book\.yml)$/
     @listener = Listen.to('.')
     @listener.filter(filter_regex)
 
@@ -44,7 +44,7 @@ module Softcover::Commands::Server
                       'Building...'
     t = Time.now
     builder = Softcover::Builders::Html.new
-    builder.build(preserve_tex: true)
+    builder.build
     puts "Done. (#{(Time.now - t).round(2)}s)"
 
   rescue Softcover::BookManifest::NotFound => e

data/lib/softcover/directories.rb

@@ -0,0 +1,5 @@
+module Softcover::Directories
+  CONFIG = 'config'
+  TMP    = 'tmp'
+  STYLES = 'latex_styles'
+end

data/lib/softcover/server/app.rb

@@ -5,7 +5,7 @@ require 'sinatra/async'
 class Softcover::App < Sinatra::Base
   register Sinatra::Async
 
-  set :public_folder, File.join(File.dirname(__FILE__),'../template/html')
+  set :public_folder, 'html'
   set :bind, '0.0.0.0'
 
   configure do
@@ -28,30 +28,6 @@ class Softcover::App < Sinatra::Base
     coffee erb :'main.js'
   end
 
-  get '/stylesheets/pygments.css' do
-    content_type 'text/css'
-    @pygments_css ||= Pygments.send(:mentos, :css, ['html', '']).
-                               gsub!(/^/, '.highlight ')
-  end
-
-  # Gets the image specified by the path and content type.
-  get '/images/*' do |path|
-    split_path = path.split(/\./)
-    extension = split_path.pop
-    path = split_path * ''
-    # Arrange to handle both '.jpeg' and '.jpg' extensions.
-    if extension == 'jpeg' && !File.exist?(image_filename(path, extension))
-      extension = 'jpg'
-    end
-    file_path = image_filename(path, extension)
-    if File.exists?(file_path)
-      content_type extension
-      File.read(file_path)
-    else
-      raise Sinatra::NotFound
-    end
-  end
-
   get '/assets/:path' do
     extension = params[:path].split('.').last
     content_type extension

data/lib/softcover/server/views/book.html.erb

@@ -4,6 +4,7 @@
     <meta charset="UTF-8">
     <link href="stylesheets/pygments.css" media="screen" rel="stylesheet" type="text/css" />
     <link href="stylesheets/softcover.css" media="screen" rel="stylesheet" type="text/css" />
+    <link href="stylesheets/custom.css" media="screen" rel="stylesheet" type="text/css" />
     <% if @local_server %>
       <script src="/jquery/1.10.2/jquery-1.10.2.js" ></script>
       <link href="assets/main.css" media="screen" rel="stylesheet" type="text/css" />

data/lib/softcover/template/chapters/a_chapter.tex

@@ -52,8 +52,8 @@ current\_\-user
 
 \begin{codelisting}
 \label{code:custom}
-\codecaption{Defining custom commands. \\ \filepath{custom.sty}}
-%= <<(custom.sty, lang: tex)
+\codecaption{Defining custom commands. \\ \filepath{latex\_styles/custom.sty}}
+%= <<(latex_styles/custom.sty, lang: tex)
 \end{codelisting}
 
 Listing~\ref{code:hyphenation} also shows how to escape the underscore character using a backslash. This is necessary because plain underscores are reserved for math environments (Section~\ref{sec:mathematics}).

data/lib/softcover/template/{book.yml.erb → config/book.yml.erb}

@@ -7,6 +7,5 @@ description: Change me.
 author: Author Name
 copyright: <%= Time.new.year %>
 uuid: <%= SecureRandom.uuid %>
-cover: images/cover.png
 pdf_preview_page_range: 1..30
 epub_mobi_preview_chapter_range: 0..1

data/lib/softcover/template/config/marketing.yml

@@ -0,0 +1,71 @@
+---
+prices:
+  -
+    code: ebooks
+    name: "HTML & Ebook"
+    description:
+      |
+        Optimized for Kindle* and iPad
+        Almost 9000 pages of content
+        Includes a free copy of 1st Edition PDF
+    media:
+      - html
+      - pdf
+      - epub
+      - mobi
+    price: 3500
+
+  -
+    code: screencasts
+    name: "HTML & Screencasts"
+    description:
+      |
+        Full updated for the 2nd edition
+        100% DRM-free digital downloads
+        (QuickTime and Ogg Vorbis)
+        Includes first edition screencasts
+    media:
+      - html
+      - screencasts
+    price: 12500
+
+  -
+    code: all
+    name: "HTML, Ebook, and Screencasts"
+    description:
+      |
+        Includes all 50 screencasts
+        eBook formats for Kindle, Nook, and PDF
+        Read online.
+    media:
+      - html
+      - pdf
+      - epub
+      - mobi
+      - screencasts
+    price: 12500
+    regular_price: 19900
+
+faq:
+  -
+    question: "Question 1 text"
+    answer: "Answer 1 text"
+
+  -
+    question: "Question 2 text"
+    answer: "Answer 2 text"
+
+testimonials:
+  -
+    name: "Person 1"
+    title: "Person 1 Title"
+    image: /images/testimonial_1.png
+    text: "Testimonial 1 text"
+
+  -
+    name: "Person 2"
+    title: "Person 2 Title"
+    gravatar_email: "info@softcover.io"
+    text: "Testimonial 2 text"
+
+marketing_content: ''

data/lib/softcover/template/html/stylesheets/custom.css

@@ -0,0 +1,15 @@
+/* Place custom styles here, scoped by the CSS id '#book' */
+/* To sync up PDF styles, edit custom.sty */
+/* Google for "LaTeX style files" to learn how to use custom.sty */
+
+/*
+
+body #book {
+  background: green;
+}
+
+#book p {
+  color: purple;
+}
+
+*/

data/lib/softcover/template/{softcover.sty → latex_styles/softcover.sty}

@@ -19,7 +19,7 @@
 \usepackage{graphicx}
 \def\maxwidth#1{\ifdim\Gin@nat@width>#1 #1\else\Gin@nat@width\fi}
 % Commands included by PolyTeXnic
-\usepackage{polytexnic_commands}
+\usepackage{latex_styles/polytexnic_commands}
 % Links
 \definecolor{darkblue}{rgb}{0,0.18,0.45}
 \definecolor{darkgreen}{rgb}{0,0.39,0}
@@ -32,7 +32,7 @@
 \hypersetup{hyperfootnotes=false}
 \hypersetup{colorlinks,linkcolor=darkblue,urlcolor=blue}
 % Syntax highlighting
-\usepackage{pygments}
+\usepackage{latex_styles/pygments}
 % Change color of '@go', "general output", from gray to dark green.
 \expandafter\def\csname PY@tok@go\endcsname{\def\PY@tc##1{\textcolor{darkgreen}{##1}}}
 % American Mathematical Society extensions
@@ -71,7 +71,7 @@
 % Use a nice font in code environments.
 \usepackage[scaled=0.92]{helvet}
 % Fix quotes in code environments
-\usepackage{upquote}
+\usepackage{latex_styles/upquote}
 
 % Filesystem paths
 \newcommand{\filepath}[1]{\texttt{\small #1}}
@@ -125,7 +125,7 @@
 \usepackage{amsthm}
 \theoremstyle{definition}
 \newtheorem{aside}{Box}[chapter]
-\usepackage{framed}
+\usepackage{latex_styles/framed}
 \definecolor{shadecolor}{gray}{0.97}
 \definecolor{boxcolor}{gray}{0.10}
 \newenvironment{shaded_aside}[2]{\begin{full_framed_shaded}\begin{aside}\label{#2} \textbf{#1}\end{aside}}{\bigskip\end{full_framed_shaded}}
@@ -143,6 +143,6 @@
     \vskip0.5em}%
 }
 
-% Add custom commands
-\usepackage{custom}
+% Add custom commands.
+\usepackage{latex_styles/custom}
 

data/lib/softcover/uploader.rb

@@ -35,9 +35,15 @@ module Softcover
           last_chunk = 0
           c.on_progress do |_, _, ul_total, ul_now|
             uploaded = ul_now > size ? size : ul_now
-
-            bar.send(:title=, "#{path} (#{as_size uploaded} / #{as_size size})")
-            bar.progress += ul_now - last_chunk rescue nil
+            x = as_size(uploaded)
+            y = as_size(size)
+            x = y if x > y
+            begin
+              bar.send(:title=, "#{path} (#{x} / #{y})")
+              bar.progress += ul_now - last_chunk
+            rescue
+              nil
+            end
             last_chunk = ul_now
             true
           end

data/lib/softcover/utils.rb

@@ -110,7 +110,7 @@ module Softcover::Utils
     subtitle = manifest.subtitle.nil? ? "" : "\\subtitle{#{manifest.subtitle}}"
     <<-EOS
 \\documentclass[14pt]{extbook}
-\\usepackage{softcover}
+\\usepackage{#{Softcover::Directories::STYLES}/softcover}
 \\VerbatimFootnotes % Allows verbatim text in footnotes
 \\title{#{manifest.title}}
 #{subtitle}
@@ -124,16 +124,17 @@ module Softcover::Utils
   # Returns the tmp version of a filename.
   # E.g., tmpify('foo.tex') => 'foo.tmp.tex'
   def tmpify(manifest, filename)
-    mkdir 'tmp'
+    tmp = Softcover::Directories::TMP
+    mkdir tmp
     sep = File::SEPARATOR
-    filename.sub(manifest.polytex_dir + sep, 'tmp' + sep).
+    filename.sub(manifest.polytex_dir + sep, tmp + sep).
              sub('.tex', '.tmp.tex')
   end
 
   # Writes a Pygments style file.
   # We support both :html (outputting CSS) and :latex (outputting
   # a LaTeX style file).
-  def write_pygments_file(format, path = '.')
+  def write_pygments_file(format, path)
     require 'pygments'
     extension = case format
                 when :html

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "0.7.11"
+  VERSION = "0.8.0"
 end

data/softcover.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'polytexnic', '~> 0.7.6'
+  gem.add_dependency 'polytexnic', '~> 0.8.0'
   gem.add_dependency 'msgpack', '~> 0.4.2'
   gem.add_dependency 'nokogiri', '~> 1.6.0'
   gem.add_dependency 'thor'

data/spec/app_spec.rb

@@ -13,7 +13,7 @@ describe Softcover::App do
       generate_book
       Softcover::Builders::Html.new.build!
     end
-    after(:all)  { remove_book }
+    # after(:all)  { remove_book }
 
     before { chdir_to_book }
 
@@ -45,11 +45,22 @@ describe Softcover::App do
     end
 
     describe 'serving files' do
+
       it 'GET pygments.css' do
         get '/stylesheets/pygments.css'
         expect_server_response_of_type 'text/css'
       end
 
+      it 'GET softcover.css' do
+        get '/stylesheets/softcover.css'
+        expect_server_response_of_type 'text/css'
+      end
+
+      it 'GET custom.css' do
+        get '/stylesheets/custom.css'
+        expect_server_response_of_type 'text/css'
+      end
+
       it 'GET main.js' do
         get '/main.js'
         expect_server_response_of_type 'application/javascript'

data/spec/book_manifest_spec.rb

@@ -12,7 +12,6 @@ describe Softcover::BookManifest do
         its(:title) { should eq "Title of the Book" }
         its(:subtitle) { should eq "Change me" }
         its(:description) { should eq "Change me." }
-        its(:cover) { should eq "images/cover.png" }
         its(:author) { should eq "Author Name" }
       end
 

data/spec/book_spec.rb

@@ -6,28 +6,36 @@ describe Softcover::Book do
       before(:all) { generate_book(id: 1) }
       after(:all)  { remove_book }
 
-      # disabling these tests for now:
-      its(:filenames) { should_not include "html/test-book.html"}
+      describe "reading from book.yml" do
+        its(:filenames) { should_not include "html/test-book.html"}
 
-      its(:filenames) { should include "html/chapter-1_fragment.html"}
-      its(:filenames) { should_not include "html/chapter-1.html"}
+        its(:filenames) { should include "html/chapter-1_fragment.html"}
+        its(:filenames) { should_not include "html/chapter-1.html"}
 
-      its(:filenames) { should include "ebooks/test-book.mobi"}
-      its(:filenames) { should include "ebooks/test-book.epub"}
-      its(:filenames) { should include "ebooks/test-book.pdf"}
+        its(:filenames) { should include "ebooks/test-book.mobi"}
+        its(:filenames) { should include "ebooks/test-book.epub"}
+        its(:filenames) { should include "ebooks/test-book.pdf"}
 
-      its(:slug) { should eq "book" }
-      its(:url) { should match /\/books\/(.*?)\/redirect/ }
+        its(:slug) { should eq "book" }
+        its(:url) { should match /\/books\/(.*?)\/redirect/ }
 
-      it "sets chapter attributes" do
-        expect(subject.chapter_attributes.first[:menu_heading]).
-          to match /Frontmatter/
+        it "sets chapter attributes" do
+          expect(subject.chapter_attributes.first[:menu_heading]).
+            to match /Frontmatter/
+        end
+
+        it "has rendered latex in menu_heading" do
+          expect(subject.chapter_attributes.last[:menu_heading]).
+            to match /<em>/
+        end
       end
 
-      it "has rendered latex in menu_heading" do
-        expect(subject.chapter_attributes.last[:menu_heading]).
-          to match /<em>/
+      describe "reading from marketing.yml" do
+        its(:prices) { should_not be_empty }
+        its(:faq) { should_not be_empty }
+        its(:testimonials) { should_not be_empty }
+        its(:marketing_content) { should be_empty }
       end
     end
   end
-end
+end

data/spec/builders/html_spec.rb

@@ -29,6 +29,16 @@ describe Softcover::Builders::Html do
         it { should match('pygments.css') }
         context "HTML document" do
           subject(:doc) { Nokogiri::HTML(output) }
+
+          context "frontmatter" do
+            subject(:frontmatter) { doc.at_css('#frontmatter') }
+            it { should_not be_nil }
+            it "should link the preface to the frontmatter page" do
+              link = '<a href="#preface"'
+              expect(frontmatter.to_xhtml).to match /#{link}/
+            end
+          end
+
           context "first chapter" do
             subject(:chapter) { doc.at_css('#cha-a_chapter') }
             it { should_not be_nil }
@@ -72,14 +82,14 @@ describe Softcover::Builders::Html do
         end
 
         describe "contents" do
-          subject(:html) { Nokogiri::HTML(File.open(filename)) }
+          subject(:doc) { Nokogiri::HTML(File.open(filename)) }
 
           it "should include the title page" do
-            expect(html.at_css('div#title_page')).not_to be_nil
+            expect(doc.at_css('div#title_page')).not_to be_nil
           end
 
           it "should include the table of contents" do
-            expect(html.at_css('div#table_of_contents')).not_to be_nil
+            expect(doc.at_css('div#table_of_contents')).not_to be_nil
           end
         end
       end
@@ -123,6 +133,10 @@ describe Softcover::Builders::Html do
         expect(Dir.glob(path('generated_polytex/*.tex'))).not_to be_empty
       end
 
+      it "should write cache files" do
+        expect(Dir.glob(path('tmp/*.cache'))).not_to be_empty
+      end
+
       describe "master LaTeX file" do
         let(:master_file) { builder.master_filename(builder.manifest) }
         subject { File.read(master_file) }

data/spec/builders/pdf_spec.rb

@@ -24,6 +24,11 @@ describe Softcover::Builders::Pdf do
         end
       end
 
+      it "should prepend the fontsize verbatim declaration for source code" do
+        fontsize = '\begin{Verbatim}[fontsize=\relsize'
+        expect(File.read(Dir.glob('tmp/*.tmp.tex').first)).to include fontsize
+      end
+
       it "should replace the main file's \\includes with tmp files" do
         contents = File.read(Softcover::Utils.tmpify(builder.manifest,
                                                      'book.tex'))
@@ -37,11 +42,14 @@ describe Softcover::Builders::Pdf do
       end
 
       it "should create a Pygments style file" do
-        expect('pygments.sty').to exist
+        pygments = File.join(Softcover::Directories::STYLES, 'pygments.sty')
+        expect(pygments).to exist
       end
 
       it "should write the correct PolyTeXnic commands file" do
-        expect(File.read('polytexnic_commands.sty')).to match /newcommand/
+        styles = File.join(Softcover::Directories::STYLES,
+                           'polytexnic_commands.sty')
+        expect(File.read(styles)).to match /newcommand/
       end
 
       context "after removing Book.txt" do

data/spec/commands/generator_spec.rb

@@ -26,7 +26,7 @@ describe Softcover::Commands::Generator do
     end
 
     describe "book.yml" do
-      subject(:yml) { YAML.load_file(File.join name, 'book.yml') }
+      subject(:yml) { YAML.load_file(File.join name, 'config', 'book.yml') }
 
       it "should have the right title" do
         expect(yml['title']).to eq "Title of the Book"
@@ -93,16 +93,22 @@ describe Softcover::Commands::Generator do
       describe "CSS" do
 
         let(:css_file) { 'html/stylesheets/softcover.css' }
+        let(:custom_css) { 'html/stylesheets/custom.css' }
 
         it "should have the right CSS file" do
           expect(css_file).to exist
         end
+
+        it "should have a custom CSS file" do
+          expect(custom_css).to exist
+        end
       end
 
       describe "styles" do
 
         it "should have a right style file" do
-          expect('softcover.sty').to exist
+          style = File.join(Softcover::Directories::STYLES, 'softcover.sty')
+          expect(style).to exist
         end
       end
 

data/spec/webmock_helpers.rb

@@ -59,8 +59,11 @@ module WebmockHelpers
            slug: book.slug,
            subtitle: book.subtitle,
            description: book.description,
-           cover: book.cover,
-           chapters: book.chapter_attributes
+           chapters: book.chapter_attributes,
+           prices: book.prices,
+           faq: book.faq,
+           testimonials: book.testimonials,
+           marketing_content: ''
         }.to_json,
            :headers => headers).
       to_return(:status => 200, :body => return_body, :headers => {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 0.7.11
+  version: 0.8.0
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polytexnic
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -374,6 +374,12 @@ files:
 - .pull_requests/1386099285
 - .pull_requests/1386115582
 - .pull_requests/1386448492
+- .pull_requests/1387399930
+- .pull_requests/1387400263
+- .pull_requests/1387592428
+- .pull_requests/1387944330
+- .pull_requests/1388094706
+- .pull_requests/1388441218
 - .rspec
 - Gemfile
 - LICENSE.txt
@@ -403,6 +409,7 @@ files:
 - lib/softcover/commands/publisher.rb
 - lib/softcover/commands/server.rb
 - lib/softcover/config.rb
+- lib/softcover/directories.rb
 - lib/softcover/formats.rb
 - lib/softcover/mathjax.rb
 - lib/softcover/output.rb
@@ -419,7 +426,6 @@ files:
 - lib/softcover/template/.softcover-deploy
 - lib/softcover/template/Book.txt
 - lib/softcover/template/README.md
-- lib/softcover/template/book.yml.erb
 - lib/softcover/template/chapters/a_chapter.md
 - lib/softcover/template/chapters/a_chapter.tex
 - lib/softcover/template/chapters/another_chapter.md
@@ -428,11 +434,11 @@ files:
 - lib/softcover/template/chapters/preface.tex
 - lib/softcover/template/chapters/yet_another_chapter.md
 - lib/softcover/template/chapters/yet_another_chapter.tex
-- lib/softcover/template/custom.sty
+- lib/softcover/template/config/book.yml.erb
+- lib/softcover/template/config/marketing.yml
 - lib/softcover/template/epub/OEBPS/styles/.gitkeep
 - lib/softcover/template/epub/OEBPS/styles/epub.css
 - lib/softcover/template/epub/OEBPS/styles/page-template.xpgt
-- lib/softcover/template/framed.sty
 - lib/softcover/template/gitignore
 - lib/softcover/template/html/.gitkeep
 - lib/softcover/template/html/MathJax/MathJax.js
@@ -973,15 +979,19 @@ files:
 - lib/softcover/template/html/jquery/1.10.2/jquery-1.10.2.js
 - lib/softcover/template/html/jquery/1.10.2/jquery-1.10.2.min.map
 - lib/softcover/template/html/stylesheets/.gitkeep
+- lib/softcover/template/html/stylesheets/custom.css
 - lib/softcover/template/html/stylesheets/softcover.css
 - lib/softcover/template/images/.gitkeep
 - lib/softcover/template/images/2011_michael_hartl.png
+- lib/softcover/template/images/cover-web.png
 - lib/softcover/template/images/cover.pdf
 - lib/softcover/template/images/cover.png
 - lib/softcover/template/images/figures/.gitkeep
-- lib/softcover/template/polytexnic_commands.sty
-- lib/softcover/template/softcover.sty
-- lib/softcover/template/upquote.sty
+- lib/softcover/template/latex_styles/custom.sty
+- lib/softcover/template/latex_styles/framed.sty
+- lib/softcover/template/latex_styles/softcover.sty
+- lib/softcover/template/latex_styles/upquote.sty
+- lib/softcover/template/screencasts/.gitkeep
 - lib/softcover/uploader.rb
 - lib/softcover/utils.rb
 - lib/softcover/version.rb

data/lib/softcover/template/polytexnic_commands.sty

@@ -1 +0,0 @@
-% Don't edit this file; it is overwritten every time the PDF gets built.