softcover 0.9.23 → 1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e52c2d46c2c93d04f42a525c55f006ac451feb66
-  data.tar.gz: 642848689b0b9419132cb12d3d41077e38a0d821
+  metadata.gz: 07316c46b4a5618e9456de93af46e5bbb111ba9c
+  data.tar.gz: 915b545aaa9fdaf36207fb95d8a7671d8627939c
 SHA512:
-  metadata.gz: a7c27be993df17653ec60d2ef765f50472f4e324d74a1e7ef2f024367166210831ec2ab78aa4ac3b4c6c004398128dc1977c87e1e1280ee2459a3eba4e1e2d22
-  data.tar.gz: b0ac15249fb787f9fe1a748da17e0a4773a0d44eb42abf0d18b121fdeff2401d3909646c89b76aa8a06cfe143ce3bf3efe6fcdd6fb11a3ab91166a003b911724
+  metadata.gz: f02e3ee81191ad6d8731df6c1bcd6a94c134a7e0595a1039671e0f94bb2158dd581fa606127324e08db7a9c9e9fbfb2ad6cf64d4e2c3f172b580b23b97b780d8
+  data.tar.gz: d0770ea2d5d9c20f45ca27fef220431ea7f489b59976d1a4b1ef23557ae2a327856902aba861b7fcfe3e643920e51766f200c43ea757ef5f8c6fadda3689405f

data/Gemfile

@@ -13,7 +13,7 @@ LC_ALL="en_US.UTF-8"
 gemspec
 
 group :test do
-  gem 'rspec'
+  gem 'rspec', '2.14.1'
   gem 'webmock',   require: false
   gem 'coveralls', require: false
   gem 'rack-test'

data/lib/softcover/builders/epub.rb

@@ -1,7 +1,35 @@
 module Softcover
+
+  module EpubUtils
+
+    # Returns the name of the cover file.
+    # We support (in order) JPG/JPEG, PNG, and TIFF.
+    def cover_img
+      extensions = %w[jpg jpeg png tiff]
+      extensions.each do |ext|
+        file = Dir[path("#{images_dir}/cover.#{ext}")].first
+        return File.basename(file) if file
+      end
+      return false
+    end
+
+    def cover?
+      cover_img
+    end
+
+    def cover_img_path
+      path("#{images_dir}/#{cover_img}")
+    end
+
+    def images_dir
+      path('epub/OEBPS/images')
+    end
+  end
+
   module Builders
     class Epub < Builder
       include Softcover::Output
+      include Softcover::EpubUtils
 
       def build!(options={})
         @preview = options[:preview]
@@ -121,10 +149,6 @@ module Softcover
         end
       end
 
-      def images_dir
-        File.join('epub', 'OEBPS', 'images')
-      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
@@ -398,25 +422,10 @@ module Softcover
 )
       end
 
-      # Returns the name of the cover file.
-      # We support (in order) JPG/JPEG, PNG, and TIFF.
-      def cover_img
-        extensions = %w[jpg jpeg png tiff]
-        extensions.each do |ext|
-          file = Dir[path("#{images_dir}/cover.#{ext}")].first
-          return File.basename(file) if file
-        end
-        return false
-      end
-
       def cover_id
         "img-#{cover_img.sub('.', '-')}"
       end
 
-      def cover?
-        cover_img
-      end
-
       # Returns the Table of Contents for the spine.
       def toc_ncx
         title = manifest.title

data/lib/softcover/builders/html.rb

@@ -88,7 +88,8 @@ module Softcover
           # interim.
           unless (File.exist?(chapter.cache_filename) &&
                   File.read(chapter.cache_filename) == digest(markdown) &&
-                  File.exist?(polytex_filename))
+                  File.exist?(polytex_filename) &&
+                  !markdown.include?('\input'))
             File.write(polytex_filename, polytex(chapter, markdown))
           end
         end

data/lib/softcover/builders/mobi.rb

@@ -1,6 +1,8 @@
 module Softcover
   module Builders
     class Mobi < Builder
+      include Softcover::Utils
+      include Softcover::EpubUtils
 
       def build!(options={})
         Softcover::Builders::Epub.new.build!(options)
@@ -12,10 +14,6 @@ module Softcover
         else
           system(command)
         end
-        if options[:calibre]
-          FileUtils.mv("ebooks/#{filename}.azw3", "ebooks/#{filename}.mobi")
-          puts "MOBI saved to ebooks/#{filename}.mobi" unless silent
-        end
       end
 
       # Returns the filename of the MOBI (preview if necessary).
@@ -25,10 +23,11 @@ module Softcover
 
       # Returns the command for making a MOBI, based on the options.
       def mobi_command(filename, options={})
-        if options[:calibre]
-          "#{calibre} ebooks/#{filename}.epub ebooks/#{filename}.azw3"
-        else
+        if options[:kindlegen]
           "#{kindlegen} ebooks/#{filename}.epub"
+        else
+          "#{calibre} ebooks/#{filename}.epub ebooks/#{filename}.mobi" +
+          " #{calibre_options}"
         end
       end
 
@@ -38,6 +37,20 @@ module Softcover
           @calibre ||= executable(dependency_filename(:calibre))
         end
 
+        # Returns the options for the Calibre `ebook-convert` CLI.
+        def calibre_options
+          # Include both Mobipocket & KF8 formats.
+          # It took me forever to figure this out. It really should be
+          # the Calibre default.
+          opts = "--mobi-file-type both"
+          if cover?
+            opts += " --cover #{cover_img_path}"
+            # Get covers to work in Kindle desktop app.
+            opts += " --share-not-sync"
+          end
+          opts
+        end
+
         def kindlegen
           @kindlegen ||= executable(dependency_filename(:kindlegen))
         end

data/lib/softcover/cli.rb

@@ -42,9 +42,9 @@ module Softcover
                                         desc: "Find overfull hboxes",
                                         type: :boolean
       elsif format == 'mobi'
-        method_option :calibre, aliases: '-c',
-                                desc: "Use Calibre to build the MOBI",
-                                type: :boolean
+        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

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

@@ -1,9 +1,9 @@
 # A chapter
 \label{cha:a_chapter}
 
-This is the first paragraph of the Softcover Markdown template produced with the \softcover\ command-line interface. It shows how to write a document in Markdown, a lightweight markup language, augmented with the [kramdown](http://kramdown.rubyforge.org/) converter and some custom extensions, including support for embedded \PolyTeX, a subset of the powerful \LaTeX\ typesetting system.  For more information, see [*The Softcover Book*](http://manual.softcover.io/book). To learn how to easily publish (and optionally sell) documents produced with Softcover, visit [Softcover.io](http://softcover.io/). Softcover is currently in private beta; go to [Softcover.io](http://softcover.io/) to get an invitation.
+This is the first paragraph of the Softcover Markdown template produced with the \softcover\ command-line interface. It shows how to write a document in Markdown, a lightweight markup language, augmented with the [kramdown](http://kramdown.rubyforge.org/) converter and some custom extensions, including support for embedded \PolyTeX, a subset of the powerful \LaTeX\ typesetting system.  For more information, see [*The Softcover Book*](http://manual.softcover.io/book). To learn how to easily publish (and optionally sell) documents produced with Softcover, visit [Softcover.io](http://softcover.io/).
 
-This is the *second* paragraph, showing how to emphasize text.[^sample-footnote] You can also make text **bold** or _emphasize a second way_.
+This is the *second* paragraph, showing how to emphasize text.[^sample-footnote] You can also make text **bold** or _emphasize a second way_. Via embedded \PolyTeX, Softcover also supports colored text, such as \coloredtext{red}{red}, \coloredtext{CornflowerBlue}{cornflower blue}, and \coloredtexthtml{E8AB3A}{arbitrary HTML colors}.
 
 ## A section
 \label{sec:a_section}

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

@@ -1,7 +1,7 @@
 \chapter{A chapter}
 \label{cha:a_chapter}
 
-This is the first paragraph of the Softcover template. It shows how to write a document in \PolyTeX, a subset of the \LaTeX\ typesetting language optimized for ebooks. For more information, see \href{http://manual.softcover.org/book}{\emph{The Softcover Book}}. To learn how to easily publish (and optionally sell) documents produced with Softcover, visit \href{http://softcover.io/}{Softcover.io}. Softcover is currently in private beta; go to \href{http://softcover.io/}{Softcover.io} to get an invitation.
+This is the first paragraph of the Softcover template. It shows how to write a document in \PolyTeX, a subset of the \LaTeX\ typesetting language optimized for ebooks. For more information, see \href{http://manual.softcover.org/book}{\emph{The Softcover Book}}. To learn how to easily publish (and optionally sell) documents produced with Softcover, visit \href{http://softcover.io/}{Softcover.io}.
 
 This is the \emph{second} paragraph, showing how to emphasize text.\footnote{This is a footnote. It is numbered automatically.} You can also make text \textbf{bold} or \textit{italicized} (which looks the same as emphasized text).
 

data/lib/softcover/template/latex_styles/softcover.sty

@@ -11,10 +11,10 @@
 
 % Font encodings
 \usepackage[T1]{fontenc}
+% Be able to define colors
+\usepackage[svgnames]{xcolor}
 % Be able to include book covers
 \usepackage{pdfpages}
-% Be able to define colors
-\usepackage{xcolor}
 % Include graphics
 \usepackage{graphicx}
 \def\maxwidth#1{\ifdim\Gin@nat@width>#1 #1\else\Gin@nat@width\fi}
@@ -129,6 +129,7 @@
 \newcommand{\kodesize}{\smaller[0.75]}
 \newcommand{\kode}[1]{\textcolor{darkgreen}{\textbf{\texttt{\kodesize #1}}}}
 \newcommand{\coloredtext}[2]{\textcolor{#1}{#2}}
+\newcommand{\coloredtexthtml}[2]{\textcolor[HTML]{#1}{#2}}
 
 % Subtitle command
 \usepackage{titling}

data/lib/softcover/utils.rb

@@ -197,7 +197,7 @@ module Softcover::Utils
   # Returns the system-independent file path.
   # It's nicer to write `path('foo/bar/baz')` than
   # `File.join('foo', 'bar', 'baz')`.
-  def path(path_string)
+  def path(path_string='')
     File.join(*path_string.split('/'))
   end
 

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "0.9.23"
+  VERSION = "1.0.beta1"
 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.9.10'
+  gem.add_dependency 'polytexnic', '~> 1.0.beta1'
   gem.add_dependency 'msgpack', '~> 0.4.2'
   gem.add_dependency 'nokogiri', '~> 1.6.0'
   gem.add_dependency 'thor', '~> 0.18.1'

data/spec/builders/mobi_spec.rb

@@ -17,16 +17,29 @@ describe Softcover::Builders::Mobi do
     describe "MOBI command" do
       context "default" do
         let(:command) do
-          @builder.mobi_command(@builder.mobi_filename, calibre: true)
+          @builder.mobi_command(@builder.mobi_filename)
         end
+
         it "should use Calibre's ebook-convert" do
           expect(command).to include 'ebook-convert'
         end
+
+        it "should build both kinds of Kindle files" do
+          expect(command).to include ' --mobi-file-type both'
+        end
+
+        it "should include the cover" do
+          expect(command).to include ' --cover epub/OEBPS/images/cover.jpg'
+        end
+
+        it "should configure the cover to work with Kindle desktop app" do
+          expect(command).to include ' --share-not-sync'
+        end
       end
 
       context "kindlegen" do
         let(:command) do
-          @builder.mobi_command(@builder.mobi_filename)
+          @builder.mobi_command(@builder.mobi_filename, kindlegen: true)
         end
         it "should use Amazon.com's kindlegen" do
           expect(command).to include 'kindlegen'

data/spec/cli_spec.rb

@@ -120,6 +120,12 @@ describe Softcover::CLI do
           expect(path('ebooks/book.mobi')).to exist
         end
       end
+
+      context "command-line options" do
+        subject(:options) { `softcover help build:mobi` }
+        it { should_not include 'calibre' }
+        it { should     include 'kindlegen' }
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 0.9.23
+  version: 1.0.beta1
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polytexnic
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.10
+        version: 1.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.10
+        version: 1.0.beta1
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -384,6 +384,7 @@ files:
 - .pull_requests/1388713504
 - .pull_requests/1388804598
 - .pull_requests/1395697365
+- .pull_requests/1403289532
 - .rspec
 - .travis.yml
 - Gemfile
@@ -1051,9 +1052,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14