git-scribe 0.0.9 → 0.1.0

data/.gitignore

@@ -1,2 +1,4 @@
 example/output
 output
+.DS_Store
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    git-scribe (0.0.9)
+      liquid
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    liquid (2.2.2)
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    test-unit (2.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git-scribe!
+  rake
+  test-unit

data/README.asciidoc

@@ -55,6 +55,11 @@ Check if you have everything installed properly for local generation with `check
     highlighting - ok
     fop      - ok
 
+If you are on OSX and using Homebrew http://mxcl.github.com/homebrew/ you can install dependencies easily:
+
+    $ brew install asciidoc source-highlight fop
+    $ brew install https://raw.github.com/adamv/homebrew-alt/master/non-free/kindlegen.rb
+
 Initialize a new book with `init`:
 
     $ git scribe init

data/Rakefile

@@ -1,31 +1,9 @@
-def command?(command)
-  system("type #{command} > /dev/null 2>&1")
-end
-
-#
-# Tests
-#
+require 'rake/testtask'
 
 task :default => :test
 
-desc "Run the test suite"
-task :test do
-  sh('turn test/**/*_test.rb')
-end
-
-
-#
-# Publishing
-#
-
-desc "Push a new version to Gemcutter"
-task :publish do
-  require 'git-scribe/version'
-
-  sh "gem build git-scribe.gemspec"
-  sh "gem push git-scribe-#{GitScribe::Version}.gem"
-  sh "git tag v#{GitScribe::Version}"
-  sh "git push origin v#{GitScribe::Version}"
-  sh "git push origin master"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
 end
-

data/TODO.txt

@@ -1,17 +1,7 @@
 To-Do List
 =============
 
-* git-init after git scribe init
-
-* custom site layouts
-* custom/alternate themes (stylesheets)
-* cover page for site (author, about, etc)
-* book cover (w/template)
-* generate hashes for generated assets and do not regenerate them unneccesarily
-
-* book search
-* math formula
-* generate different languages from branches/tags (site, epub, mobi)
+* move to GLI?
 
 * workflow
   - review / copy editing
@@ -19,10 +9,9 @@ To-Do List
   - edition release
   - maint branches (pegging to software revs)
 
-* amazon/ibooks/lulu integration
-
+* book search
 * site comments
 * github-side generation
-* external auto-publishing / monetization (?)
 * docbook import / direct from docbook
-
+* external auto-publishing / monetization (?)
+  - amazon/ibooks/lulu integration

data/docbook-xsl/fo.xsl

@@ -16,6 +16,10 @@
 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl"/>
 <xsl:import href="common.xsl"/>
 
+<xsl:import href="fo/verbatim.xsl"/>
+<xsl:param name="highlight.source" select="1"></xsl:param>
+<xsl:param name="highlight.xslthl.config">file:///usr/local/Cellar/docbook/5.0/docbook/xsl/1.76.1/highlighting/xslthl-config.xml</xsl:param>
+
 <xsl:param name="fop1.extensions" select="1" />
 <xsl:param name="variablelist.as.blocks" select="1" />
 

data/docbook-xsl/fo/highlight.xsl

@@ -15,18 +15,10 @@
 
      ******************************************************************** -->
 
-<xsl:template match='xslthl:keyword' mode="xslthl">
-  <fo:inline font-weight="bold"><xsl:apply-templates mode="xslthl"/></fo:inline>
-</xsl:template>
-
 <xsl:template match='xslthl:string' mode="xslthl">
   <fo:inline font-weight="bold" font-style="italic"><xsl:apply-templates mode="xslthl"/></fo:inline>
 </xsl:template>
 
-<xsl:template match='xslthl:comment' mode="xslthl">
-  <fo:inline font-style="italic"><xsl:apply-templates mode="xslthl"/></fo:inline>
-</xsl:template>
-
 <xsl:template match='xslthl:tag' mode="xslthl">
   <fo:inline font-weight="bold"><xsl:apply-templates mode="xslthl"/></fo:inline>
 </xsl:template>
@@ -39,6 +31,14 @@
   <fo:inline font-weight="bold"><xsl:apply-templates mode="xslthl"/></fo:inline>
 </xsl:template>
 
+<xsl:template match='xslthl:keyword' mode="xslthl">
+  <fo:inline font-weight="bold" color="blue"><xsl:apply-templates mode="xslthl"/></fo:inline>
+</xsl:template>
+
+<xsl:template match='xslthl:comment' mode="xslthl">
+  <fo:inline font-style="italic" color="grey"><xsl:apply-templates mode="xslthl"/></fo:inline>
+</xsl:template>
+
 <!--
 <xsl:template match='xslthl:html'>
   <span style='background:#AFF'><font color='blue'><xsl:apply-templates/></font></span>

data/docbook-xsl/xhtml/param.xsl

@@ -191,8 +191,8 @@ set       toc,title
 <xsl:param name="graphicsize.use.img.src.path" select="0"/>
 <xsl:param name="header.rule" select="1"/>
 <xsl:param name="highlight.default.language"/>
-<xsl:param name="highlight.source" select="0"/>
-<xsl:param name="highlight.xslthl.config"/>
+<xsl:param name="highlight.source" select="1"/>
+<xsl:param name="highlight.xslthl.config">file:///usr/local/Cellar/docbook/5.0/docbook/xsl/1.76.1/highlighting/xslthl-config.xml</xsl:param>
 <xsl:param name="html.append"/>
 <xsl:param name="html.base"/>
 <xsl:param name="html.cellpadding"/>

data/git-scribe.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency('nokogiri')
   s.add_dependency('liquid')
+  s.add_development_dependency("rake")
+  s.add_development_dependency("test-unit")
 
   s.executables       = %w( git-scribe )
 

data/lib/git-scribe/check.rb

@@ -42,7 +42,7 @@ class GitScribe
 
 
       # check for fop
-      if !check_can_run('fop -version')
+      if !check_can_run('fop -v -out list')
         info "fop is not present, please install for PDF generation"
         status[:fop] = false
       else
@@ -65,7 +65,7 @@ class GitScribe
 
     def check_can_run(command)
       `#{command} 2>&1`
-      $?.exitstatus == 0
+      $?.success?
     end
   end
 end

data/lib/git-scribe/generate.rb

@@ -42,7 +42,7 @@ class GitScribe
     end
 
     def a2x_wss(type)
-      a2x(type) + " --stylesheet=stylesheets/handbookish.css"
+      a2x(type) + " --stylesheet=stylesheets/scribe.css"
     end
 
     def do_docbook
@@ -57,17 +57,17 @@ class GitScribe
     def do_pdf
       info "GENERATING PDF"
       do_docbook
-      # TODO: syntax highlighting (fop?)
-      strparams = {'callout.graphics' => 0,
-                   'navig.graphics' => 0,
-                   'admon.textlabel' => 1,
-                   'admon.graphics' => 0}
-      param = strparams.map { |k, v| "--stringparam #{k} #{v}" }.join(' ')
-      cmd = "xsltproc  --nonet #{param} --output #{local('book.fo')} #{base('docbook-xsl/fo.xsl')} #{local('book.xml')}"
-      ex(cmd)
-      cmd = "fop -fo #{local('book.fo')} -pdf #{local('book.pdf')}"
-      ex(cmd)
-      if $?.exitstatus == 0
+
+      java_options = {
+        'callout.graphics' => 0,
+        'navig.graphics'   => 0,
+        'admon.textlabel'  => 1,
+        'admon.graphics'   => 0,
+      }
+      run_xslt "-o #{local('book.fo')} #{local('book.xml')} #{base('docbook-xsl/fo.xsl')}", java_options
+      ex "fop -fo #{local('book.fo')} -pdf #{local('book.pdf')}"
+
+      if $?.success?
         'book.pdf'
       end
     end
@@ -97,7 +97,7 @@ class GitScribe
       info "GENERATING HTML"
       # TODO: look for custom stylesheets
       styledir = local('stylesheets')
-      cmd = "asciidoc -a stylesdir=#{styledir} -a theme=handbookish #{BOOK_FILE}"
+      cmd = "asciidoc -a stylesdir=#{styledir} -a theme=scribe #{BOOK_FILE}"
       if ex(cmd)
         @done['html'] == true
         'book.html'
@@ -107,9 +107,9 @@ class GitScribe
     def do_site
       info "GENERATING SITE"
       # TODO: check if html was already done
-      ex("asciidoc -b docbook #{BOOK_FILE}")
-      xsldir = base('docbook-xsl/xhtml')
-      ex("xsltproc --stringparam html.stylesheet stylesheets/handbookish.css --nonet #{xsldir}/chunk.xsl book.xml")
+
+      ex "asciidoc -b docbook #{BOOK_FILE}"
+      run_xslt "book.xml #{base('docbook-xsl/xhtml/chunk.xsl')}", "html.stylesheet" => 1
 
       source = File.read('index.html')
       html = Nokogiri::HTML.parse(source, nil, 'utf-8')
@@ -336,8 +336,18 @@ class GitScribe
     def ex(command)
       out = `#{command} 2>&1`
       info out
-      $?.exitstatus == 0
+      $?.success?
     end
 
+    private
+
+    def run_xslt(jar_arguments, java_options)
+      ex <<-SH
+        java -cp "#{base('vendor/saxon.jar')}:#{base('vendor/xslthl-2.0.2.jar')}" \
+             #{java_options.map { |k, v| "-D#{k}=#{v}" }.join(' ')} \
+             com.icl.saxon.StyleSheet \
+             #{jar_arguments}
+      SH
+    end
   end
 end

data/lib/git-scribe/version.rb

@@ -1,3 +1,3 @@
 class GitScribe
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

data/stylesheets/{handbookish.css → scribe.css}

@@ -1,4 +1,3 @@
-/* BEG */
 /* ---------------------------------------------------------------------------
    Bare AsciiDoc styles
    Ryan Tomayko <r@tomayko.com>
@@ -8,7 +7,7 @@ body {
 	font-family:verdana,helvetica,arial,sans-serif;
 	font-size:81.25%;   /* 13px */
 	line-height:1.538;  /* 20px */
-	margin:40px 50px;
+	margin:40px auto 50px auto;
 	max-width:53.8461538462em; /* 790px */
 	color:#333;
 }
@@ -32,7 +31,9 @@ p, ul, ol, dl {
 	margin:10px 0
 }
 
-dl { }
+dl {
+	margin-left:40px
+}
 
 dt {
 	font-weight:normal;
@@ -46,39 +47,35 @@ h1, h2, h3, h4, h5 {
 }
 
 h1 {
-	font-size:30px;
+	font-size:40px;
 	line-height:1.428;
 	margin:20px 0;
 }
 
 h2 {
-	font-size:23px;
+	font-size:30px;
 	line-height:1.36363636; /* repeating, of course */
-	margin:20px 0;
+	margin:60px 0 20px 0;
 }
 
 h2 + .sectionbody {}
 
 h3 {
-	font-size:18px;
+	font-size:24px;
 	line-height:1.1;
 	margin:30px 0 10px 0;
 }
 
 h4 {
-	font-size:13px;
-	font-weight:bold;
-	line-height:1.538;
+	font-size:18px;
+	line-height:1.1;
+	margin:20px 0 5px 0;
 }
 
 h5 {
 	font-size:13px;
 	font-style:italic;
-	line-height:1.538;
-}
-
-pre {
-	font-size:larger;
+	line-height:1.1;
 }
 
 #header { 
@@ -88,9 +85,9 @@ pre {
 
 #header h1 { margin-bottom:0 }
 
-
 .title, .sidebar-title {
 	font-weight:normal;
+	color:#000;
 	margin-bottom:0;
 }
 
@@ -112,6 +109,10 @@ pre {
 	color:#888;
 }
 
+.listingblock {
+  margin: 13px 0;
+}
+
 .listingblock .content {
 	border:1px solid silver;
 	background:#eee;
@@ -173,59 +174,4 @@ pre {
 #author {
 	color:#000;
 	text-transform:uppercase
-}
-
-/* vim: set ft=css ts=4 sw=4 noexpandtab: */
-
-/* END @import url(bare.css); */
-
-/* ---------------------------------------------------------------------------
-   FreeBSD AsciiDoc Theme
-   Ryan Tomayko <r@tomayko.com>
-
-   Based on The FreeBSD Handbook and various other FreeBSD documenration.
---------------------------------------------------------------------------- */
-
-body {
-  font-family:verdana,helvetica,arial,sans-serif;
-  font-size:100%;
-  color:#000;
-}
-
-tt { color:#007A00 }
-pre tt { color:#000 }
-
-dt { color:#000 }
-
-h1, h2, h3, h4, h5 {
-  font-family:'lucida grande',helvetica,verdana,sans-serif;
-  color:#900;
-  font-weight:bold;
-}
-
-#header {
-  text-align:left;
-}
-#header h1 { margin-bottom:40px }
-
-h1 {
-  font-size:36px;
-  line-height:1;
-  margin:40px 0;
-}
-
-h2 {
-  font-size:28px;
-  line-height:1;
-  margin:30px 0 20px 0;
-}
-
-.sectionbody {
-  margin-left:30px;
-}
-
-pre {
-  background:#EEE;
-}
-
-/* vim: set ft=css ts=4 sw=4 noexpandtab: */
+}

data/test/check_test.rb

@@ -9,4 +9,15 @@ context "scribe check tests" do
     status = @scribe.check
     assert_equal status.size, 6
   end
+
+  # there no option '-failboat' for apache fop cli
+  # it accepts only '-v' option but doesn't exit immediately.
+  # it should be additional no-op flag provided (like '-out list')
+  #
+  # see http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/src/java/org/apache/fop/cli/CommandLineOptions.java
+  test "scribe should correctly check fop availability" do
+    assert_equal @scribe.check_can_run('fop -v -out list'), true
+    assert_equal @scribe.check_can_run('fop -v'), false
+    assert_equal @scribe.check_can_run('fop -failboat'), false
+  end
 end

data/test/gen_test.rb

@@ -20,7 +20,7 @@ context "scribe gen tests" do
         out = Dir.glob('output/**/*')
         assert out.include? 'output/book.html'
         assert out.include? 'output/image'
-        assert out.include? 'output/stylesheets/handbookish.css'
+        assert out.include? 'output/stylesheets/scribe.css'
       end
     end
   end
@@ -29,22 +29,34 @@ context "scribe gen tests" do
     in_temp_dir do
       @scribe.init('t')
       Dir.chdir('t') do
-      data = @scribe.gen('site')
+        data = @scribe.gen('site')
         out = Dir.glob('output/**/*')
         assert out.include? 'output/index.html'
         assert out.include? 'output/the_first_chapter.html'
         assert out.include? 'output/the_second_chapter.html'
         assert out.include? 'output/image'
-        assert out.include? 'output/stylesheets/handbookish.css'
+        assert out.include? 'output/stylesheets/scribe.css'
       end
     end
   end
 
+  test "scribe can generate site with syntax highlighting" do
+    in_temp_dir do
+      @scribe.init('t')
+      Dir.chdir('t') do
+        @scribe.gen('site')
+        html = Nokogiri::HTML(File.read('output/the_first_chapter.html'))
+        assert html.at_css "b:contains('char')"
+      end
+    end
+  end
+
+
   test "scribe can generate a pdf" do
     in_temp_dir do
       @scribe.init('t')
       Dir.chdir('t') do
-      data = @scribe.gen('pdf')
+        data = @scribe.gen('pdf')
         assert_equal data, 'book.pdf'
         out = Dir.glob('output/**/*')
         assert out.include? 'output/book.pdf'
@@ -52,12 +64,24 @@ context "scribe gen tests" do
     end
   end
 
+  test "scribe can generate a pdf with syntax highlighting" do
+    in_temp_dir do
+      @scribe.init('t')
+      Dir.chdir('t') do
+        @scribe.gen('pdf')
+        fo = Nokogiri::XML(File.read('output/book.fo'))
+        fo.remove_namespaces!
+        assert fo.at_css "inline[font-weight=bold][color=blue]:contains('char')"
+      end
+    end
+  end
+
   test "scribe can generate a epub" do
     in_temp_dir do
       @scribe.init('t')
       Dir.chdir('t') do
       data = @scribe.gen('epub')
-        assert_equal data, 'book.epub'
+        assert_equal 'book.epub', data
         out = Dir.glob('output/**/*')
         assert out.include? 'output/book.epub'
       end

data/test/test_helper.rb

@@ -2,17 +2,15 @@ dir = File.dirname(File.expand_path(__FILE__))
 $LOAD_PATH.unshift dir + '/../lib'
 $TESTING = true
 
-require 'test/unit'
+# Necessary to override stdlib: http://www.ruby-forum.com/topic/212974
 require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+
 require 'git-scribe'
 require 'pp'
 require 'tempfile'
 
-begin
-  require 'leftright'
-rescue LoadError
-end
-
 ##
 # test/spec/mini 3
 # http://gist.github.com/25455

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-scribe
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Scott Chacon
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-28 00:00:00 -08:00
-default_executable: 
+date: 2011-09-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -46,6 +45,34 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: "  git-scribe is a workflow tool for starting, writing, reviewing and publishing\n  multiple forms of a book.  it allows you to use asciidoc plain text markup to\n  write, review and translate a work and provides a simple toolkit for generating\n  common digital outputs for publishing - epub, mobi, pdf and html.  it is also\n  integrated into github functionality, letting you automate the publishing and\n  collaboration process.\n"
 email: schacon@gmail.com
 executables: 
@@ -56,6 +83,8 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.asciidoc
 - Rakefile
@@ -1187,8 +1216,8 @@ files:
 - site/default/index.html
 - site/default/master.css
 - site/default/page.html
-- stylesheets/handbookish-quirks.css
-- stylesheets/handbookish.css
+- stylesheets/scribe-quirks.css
+- stylesheets/scribe.css
 - template/.gitignore
 - template/.gitscribe
 - template/LICENSE
@@ -1202,7 +1231,8 @@ files:
 - test/gen_test.rb
 - test/init_test.rb
 - test/test_helper.rb
-has_rdoc: true
+- vendor/saxon.jar
+- vendor/xslthl-2.0.2.jar
 homepage: http://github.com/schacon/git-scribe
 licenses: []
 
@@ -1232,7 +1262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: git-scribe is an authors toolkit for writing and publishing books