softcover 1.7.5 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f8216b104c6b6341a7ff95524712cc97fdafd2153fff6d6c69bcab3f113a06
-  data.tar.gz: 691d43d5226885e4796440ec770bd0c19df2466fd180b3194a0de0f971a94c36
+  metadata.gz: ac6a3f1ecc0ba2a8ba2dc4dac7b8a480fc451acd10c563b5a5a5a55209c4d6cf
+  data.tar.gz: caa2837b7e97298887d0a927c84e6973bd4fe5857f29b2fc80eea0f18533417f
 SHA512:
-  metadata.gz: 5a891f8b339375b86a3a4259b7fc9dc07d7f57aa1e2da8d8df3448ad2866a12af4c0ded3720675cbf33dd79121cf33cd4c6e590f096e91015684472a2cb5600c
-  data.tar.gz: 101c6147113f550d1b56109ec33da95559198f7cd03e14838fd1b0bf44a5a127203d0f4a5e8c95d1960d34454fdcf05a6f1f5bc70298e11097078c1f7be0f23e
+  metadata.gz: 31e8000d8dc51018be5e76ecab96fbac5b5373c9d3a9df2a05085844d20da0ae6251dca92c09c3860f35224b9ec903c81a327e8ef78deb1ecebaa81b64049c30
+  data.tar.gz: c706ab7791768ea06cd05caa5c80ce34a669015425d35ba63a14df6e05b0c8234cd220c6fcf9c035d1c35d4936449119321db01fbfeeab9c5531bc80265bcd40

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    softcover (1.7.5)
+    softcover (1.8.0)
       activesupport (~> 4.2.3)
       async_sinatra (~> 1.1.0)
       coffee-script (>= 2.2.0)
@@ -12,7 +12,7 @@ PATH
       maruku (~> 0.7.1)
       msgpack (~> 1.2.0)
       nokogiri (>= 1.6.0, < 2.0)
-      polytexnic (~> 1.7.2)
+      polytexnic (~> 1.8.0)
       pygments.rb (~> 2.1)
       rest-client (>= 1.8.0)
       ruby-progressbar (~> 1.10)
@@ -30,8 +30,8 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     async_sinatra (1.1.0)
       rack (>= 1.4.1)
       sinatra (>= 1.3.2)
@@ -50,7 +50,7 @@ GEM
     crack (0.4.5)
       rexml
     crass (1.0.6)
-    curb (1.0.0)
+    curb (1.0.1)
     daemons (1.4.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
@@ -61,12 +61,12 @@ GEM
     ffi (1.15.5)
     hashdiff (1.0.1)
     http-accept (1.7.0)
-    http-cookie (1.0.4)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     json (2.3.1)
-    kramdown (2.3.2)
+    kramdown (2.4.0)
       rexml
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -76,14 +76,16 @@ GEM
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
-    minitest (5.15.0)
+    minitest (5.16.3)
     msgpack (1.2.10)
     netrc (0.11.0)
-    nokogiri (1.13.3-x86_64-darwin)
+    nokogiri (1.13.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.10-x86_64-darwin)
       racc (~> 1.4)
     nokogumbo (2.0.5)
       nokogiri (~> 1.8, >= 1.8.4)
-    polytexnic (1.7.2)
+    polytexnic (1.8.0)
       json (~> 2.3.0)
       kramdown (>= 2.0, < 3.0)
       msgpack (~> 1.2.0)
@@ -92,16 +94,16 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
-    pygments.rb (2.3.0)
-    racc (1.6.0)
+    public_suffix (5.0.1)
+    pygments.rb (2.3.1)
+    racc (1.6.1)
     rack (1.6.13)
     rack-protection (1.5.5)
       rack
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rake (13.0.6)
-    rb-fsevent (0.11.1)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rest-client (2.1.0)
@@ -145,21 +147,23 @@ GEM
       rack (~> 1.0)
     thor (1.2.1)
     thread_safe (0.3.6)
-    tilt (2.0.10)
-    tins (1.31.0)
+    tilt (2.0.11)
+    tins (1.32.1)
       sync
-    tzinfo (1.2.9)
+    tzinfo (1.2.10)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8.1)
-    webmock (3.14.0)
+    unf_ext (0.0.8.2)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-19
+  x86_64-darwin-21
 
 DEPENDENCIES
   coveralls

data/README.md

@@ -1,6 +1,6 @@
 # Softcover
 
-[![CircleCI](https://circleci.com/gh/softcover/softcover.svg?style=shield)](https://circleci.com/gh/softcover/softcover) [![Coverage Status](https://coveralls.io/repos/softcover/softcover/badge.svg)](https://coveralls.io/github/softcover/softcover)
+[![Coverage Status](https://coveralls.io/repos/softcover/softcover/badge.svg)](https://coveralls.io/github/softcover/softcover)
 
 Softcover is an ebook typesetting system for technical authors. This is the main gem, `softcover`, which depends on `polytexnic` to convert Markdown or PolyTeX input to HTML and LaTeX, and thence to EPUB, MOBI, and PDF. Authors can use Softcover to publish and optionally sell the resulting ebooks (as well as associated digital goods such as screencasts) on the [Softcover publishing platform](http://www.softcover.io/).
 

data/lib/softcover/article_template/latex_gitignore

@@ -8,7 +8,6 @@ tmp/
 generated_polytex/
 
 .highlight_cache
-.softcover-book
 
 # Generated HTML files
 html/*.html

data/lib/softcover/article_template/latex_styles/softcover.sty

@@ -40,6 +40,7 @@
 % American Mathematical Society extensions
 \usepackage{amsmath}
 \usepackage{amsfonts}
+\usepackage{amssymb}
 % 'Verbatim' environment
 \usepackage{fancyvrb}
 % Be able to resize text relative to other text

data/lib/softcover/article_template/markdown_gitignore

@@ -9,7 +9,6 @@ tmp/
 generated_polytex/
 
 .highlight_cache
-.softcover-book
 
 # Generated HTML files
 html/*.html

data/lib/softcover/book_template/latex_gitignore

@@ -8,7 +8,6 @@ tmp/
 generated_polytex/
 
 .highlight_cache
-.softcover-book
 
 # Generated HTML files
 html/*.html

data/lib/softcover/book_template/latex_styles/softcover.sty

@@ -40,6 +40,7 @@
 % American Mathematical Society extensions
 \usepackage{amsmath}
 \usepackage{amsfonts}
+\usepackage{amssymb}
 % 'Verbatim' environment
 \usepackage{fancyvrb}
 % Be able to resize text relative to other text

data/lib/softcover/book_template/markdown_gitignore

@@ -9,7 +9,6 @@ tmp/
 generated_polytex/
 
 .highlight_cache
-.softcover-book
 
 # Generated HTML files
 html/*.html

data/lib/softcover/builders/epub.rb

@@ -273,6 +273,12 @@ module Softcover
         end
       end
 
+      # Escapes spaces in filename directories.
+      # E.g., "Mobile Directory" becomes "Mobile\ Directory".
+      def escape_spaces(name)
+        name.gsub(' ', '\ ')
+      end
+
       # Returns HTML for HTML source that includes math.
       # As a side-effect, html_with_math creates PNGs corresponding to any
       # math in the given source. The technique involves using PhantomJS to
@@ -285,7 +291,8 @@ module Softcover
         content = File.read(File.join("html",
                                       "#{chapter.slug}.#{html_extension}"))
         pagejs = "#{File.dirname(__FILE__)}/utils/page.js"
-        url = "file://#{Dir.pwd}/html/#{chapter.slug}.#{html_extension}"
+        dir = escape_spaces(Dir.pwd)
+        url = "file://" + dir + "/html/#{chapter.slug}.#{html_extension}"
         cmd = "#{phantomjs} #{pagejs} #{url}"
         silence { silence_stream(STDERR) { system cmd } }
         # Sometimes in tests the phantomjs_source.html file is missing.

data/lib/softcover/cli.rb

@@ -99,9 +99,12 @@ module Softcover
     desc 'server', 'Run local server'
     method_option :port, type: :numeric, default: 4000, aliases: '-p'
     method_option :bind, type: :string, default: '0.0.0.0', aliases: '-o'
+    method_option :pdf, type: :boolean, default: false
+    method_option :overfull, type: :boolean, default: false
     def server
       if Softcover::BookManifest::valid_directory?
-        Softcover::Commands::Server.run options[:port], options[:bind]
+        Softcover::Commands::Server.run options[:port], options[:bind],
+                                        options[:pdf], options[:overfull]
       else
         puts 'Not in a valid book directory.'
         exit 1

data/lib/softcover/commands/exercises.rb

@@ -22,7 +22,7 @@ module Softcover
         		str += line
 
         		case line
-        		when %r{\\subsubsection{Exercises}}
+        		when %r{\\subsection{Exercises}}
         			in_exercise = true
         		when %r{\\end{enumerate}}
         			in_exercise = false

data/lib/softcover/commands/server.rb

@@ -7,14 +7,14 @@ module Softcover::Commands::Server
   extend self
 
   # Listens for changes to the book's source files.
-  def listen_for_changes
+  def listen_for_changes(is_pdf=false, overfull=false)
     return if defined?(@no_listener) && @no_listener
     server_pid = Process.pid
     filter_regex = /(\.md|\.tex|custom\.sty|custom\.css|Book\.txt|book\.yml)$/
     @listener = Listen.to('.', only: filter_regex, ignore: /html\//) do |modified|
       first_modified = modified.try(:first)
       unless first_modified =~ ignore_regex
-        rebuild first_modified
+        rebuild(is_pdf, modified: first_modified, overfull: overfull)
         Process.kill("HUP", server_pid)
       end
     end
@@ -37,30 +37,42 @@ module Softcover::Commands::Server
     !Dir.glob(path('chapters/*.md')).empty?
   end
 
-  def rebuild(modified=nil)
+  def rebuild(is_pdf, modified: nil, overfull: nil)
     printf modified ? "=> #{File.basename modified} changed, rebuilding... " :
                       'Building...'
     t = Time.now
-    builder = Softcover::Builders::Html.new
-    builder.build
+
+    if is_pdf
+      if overfull
+        options = "--find-overfull"
+      else
+        options = "--once --nonstop --quiet"
+      end
+      system "softcover build:pdf #{options}"
+    else
+      builder = Softcover::Builders::Html.new
+      builder.build
+    end
     puts "Done. (#{(Time.now - t).round(2)}s)"
 
   rescue Softcover::BookManifest::NotFound => e
     puts e.message
   end
 
-  def start_server(port, bind)
+  def start_server(port, bind, is_pdf)
     require 'softcover/server/app'
-    puts "Running Softcover server on http://#{bind}:#{port}"
     Softcover::App.set :port, port
-    Softcover::App.set :bind, bind
+    unless is_pdf
+      puts "Running Softcover server on http://#{bind}:#{port}"
+      Softcover::App.set :bind, bind
+    end
     Softcover::App.run!
   end
 
-  def run(port, bind)
-    rebuild
-    listen_for_changes
-    start_server port, bind
+  def run(port, bind, is_pdf, overfull)
+    rebuild(is_pdf, overfull: overfull)
+    listen_for_changes(is_pdf, overfull)
+    start_server port, bind, is_pdf
   end
 end
 

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "1.7.5"
+  VERSION = "1.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', '~> 1.7.2'
+  gem.add_dependency 'polytexnic', '~> 1.8.0'
   gem.add_dependency 'msgpack', '~> 1.2.0'
   gem.add_dependency 'nokogiri', '>= 1.6.0', '< 2.0'
   gem.add_dependency 'thor', '>= 0.18.1', '< 2.0'

data/spec/commands/server_spec.rb

@@ -13,10 +13,12 @@ describe Softcover::Commands::Server do
   it '#run' do
     Softcover::App.should_receive :run!
 
-    port = 5000
-    bind = "localhost"
+    port     = 5000
+    bind     = "localhost"
+    pdf      = false
+    overfull = false
 
-    subject.run port, bind
+    subject.run port, bind, pdf, overfull
 
     expect(Softcover::App.port).to eq port
     expect(Softcover::App.bind).to eq bind

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.8.0
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polytexnic
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement