git-scribe 0.0.4 → 0.0.5

data/.gitignore

@@ -0,0 +1 @@
+example/output

data/Rakefile

@@ -0,0 +1,31 @@
+def command?(command)
+  system("type #{command} > /dev/null 2>&1")
+end
+
+#
+# Tests
+#
+
+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"
+end
+

data/SPEC.asciidoc

@@ -0,0 +1,126 @@
+The Dream
+=========
+
+This is where I'm documenting basically what I want the README to eventually look like.  This is sort of my Document Driven Development file.  I'm trying to envision what the git-scribe project should look like as I write the tool.  I didn't want it to be in the readme yet so as not to confuse people.  All the commands are just ideas and what not.  If you have an idea of how you would like things to look, add them here and send a pull request.
+
+I want to get the full workflows worked out here (with technical details) before I even try to implement them.
+
+Start a Book
+============
+
+    $ git scribe init (--type=[code,math]) (--license=[public,cc]) (--lang=en) [project]
+
+Generates a skeleton, license file and readmes with instructions for authors and contributors.
+Also records version of scribe workflow we're using into .gitscribe file.
+
+* shows cheat-sheet of how to use grep, tag, diff (--word)
+
+Work on a Book
+==============
+
+    $ git scribe check
+
+Run checks to make sure you have all the tools you need and your system can do stuff.
+
+    $ git scribe register (--role=[author,reviewer,editor,translator])
+
+Register yourself and your role in this book.
+  kept in .git/scribe
+
+To Do List
+==========
+
+    $ git scribe todo
+
+* lists boilerplate you still haven't filled out 
+  (title, author, description, chapter, cover, bio, biblio, price, license, etc)
+  most of that is kept in .gitscribe
+
+Writing
+=======
+
+    $ git scribe new chapter
+
+Editing
+=======
+
+    $ git scribe review
+
+TODO: address technical reviewing and copy-editing
+
+Translating - Translator
+========================
+
+    $ git scribe trans start (--edition=1.1) de
+
+Sets up pre-commit hook to check that commit message is formatted correctly, copies over main language to 'de'
+
+http://en.wikipedia.org/wiki/IETF_language_tag
+
+    $ git scribe trans changes (--since=2010-01-01)
+
+    $ git scribe trans done SHA
+
+Translating - Maintainer
+========================
+
+    $ git scribe trans complete
+
+See which translations are what percent complete.
+
+- get list of translators for each translation
+
+Editions
+========
+This is meant to be done infrequently - like an edition of a book or a major version of a framework that is being documented.  Publishing editions too often makes work difficult on translators, so be prudent.
+
+    $ git scribe --tool-version=1.7 publish [major|minor]
+
+Tags the edition with the next major or minor number, generates a branch for maintainance for this edition.
+
+Generate Media
+==============
+
+    $ git scribe gen (--lang=de) (--edition=1.0) [site,pdf,mobi,epub]
+
+OR
+
+    $ git push origin
+
+Sell
+====
+
+    $ git scribe sell --price=8.00 [--lang=de] (ibooks,kindle,nook,lulu)
+
+
+Layout
+======
+
+The layout that the `git scribe init` produces looks like this:
+
+[source]
+----
+* book/
+|`--* book.asc
+|`--* 01_first_chapter.asc
+|`--* 02_second_chapter.asc
+|`--* 99_backmatter.asc
+|`--* image/
+|    `--* 01.01-example-image.png
+|    `--* 01.02-another-image.png
+|    `--* 02.01-an-image.png
+|`--* include/
+|    `--* 02.01-code.c
+* style/
+|`--* style.css
+* site/
+|`--* layout.html
+* test/
+|`--* 01_test.rb
+* LICENSE.txt
+* README.asciidoc
+* .gitscribe
+----
+
+Not all of those files would be generated (like the test files and the site files which are overrides for the site templates), but examples would and it would give a usable starting point for new authorship.  This example would be a valid and somewhat complex layout.
+

data/TODO.txt

@@ -0,0 +1,29 @@
+To-Do List
+=============
+
+* custom site layouts
+* custom/alternate themes (stylesheets)
+* mobi generation
+* cover page for site (author, about, etc)
+* book cover (w/template)
+* github pages publishing
+* checking for proper tools
+* book search
+* math formula
+* generate different languages from branches/tags (site, epub, mobi)
+
+* use options library
+
+* workflow
+  - review / copy editing
+  - translation
+  - edition release
+  - maint branches (pegging to software revs)
+
+* amazon/ibooks/lulu integration
+
+* site comments
+* github-side generation
+* external auto-publishing / monetization (?)
+* docbook import / direct from docbook
+

data/bin/git-scribe

@@ -2,5 +2,6 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 
 require 'git-scribe'
+require 'git-scribe/cli'
 
-GitScribe.start
+GitScribe.new.run

data/docbook-xsl/.CatalogManager.properties.example

@@ -0,0 +1,61 @@
+######################################################################## 
+# CatalogManager provides an interface to the catalog properties.
+# Properties can come from two places: from system properties or
+# from a CatalogManager.properties file. This class provides a
+# transparent interface to both, with system properties preferred 
+# over property file values.
+
+#######################################################################
+# Catalog Files:
+# The semicolon-delimited list of catalog files.
+# Example: catalogs=/etc/xml/catalog;~/catalog.xml
+
+catalogs=
+
+#######################################################################
+# Relative Catalogs:
+# If false, relative catalog URIs are made absolute with respect to the
+# base URI of the CatalogManager.properties file. This setting only 
+# applies to catalog URIs obtained from the catalogs property in the
+# CatalogManager.properties file
+# Example: relative-catalogs = [yes|no]
+
+relative-catalogs=yes
+
+#######################################################################
+# Verbosity:
+# If non-zero, the Catalog classes will print informative and debugging
+# messages. The higher the number, the more messages.
+# Example: verbosity = [0..99]
+
+verbosity=0
+
+#######################################################################
+# Prefer:
+# Which identifier is preferred, "public" or "system"?
+# Example: xml.catalog.prefer = [public|system]
+
+prefer=system
+
+#######################################################################
+# Static-catalog:
+# Should a single catalog be constructed for all parsing, or should a
+# different catalog be created for each parser?
+# Example: static-catalog = [yes|no]
+
+static-catalog=yes
+
+#######################################################################
+# Allow-oasis-xml-catalog-pi
+# If the source document contains "oasis-xml-catalog" processing 
+# instructions, should they be used?
+# Example: allow-oasis-xml-catalog-pi = [yes|no]
+
+allow-oasis-xml-catalog-pi=yes
+
+#######################################################################
+# catalog-class-name
+# If you're using the convenience classes 
+# org.apache.xml.resolver.tools.*, this setting allows you to specify
+# an alternate class name to use for the underlying catalog.
+# Example: catalog-class-name=org.apache.xml.resolver.Resolver

data/docbook-xsl/.urilist

@@ -0,0 +1 @@
+. http://docbook.sourceforge.net/release/xsl/current/

data/git-scribe.gemspec

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift 'lib'
+
+files = `git ls-files`.
+  split("\n").
+  sort
+
+puts files
+
+  # piece file back together and write...
+Gem::Specification.new do |s|
+  s.name              = "git-scribe"
+  s.version           = "0.0.5"
+  s.date              = Time.now.strftime('%Y-%m-%d')
+  s.summary           = "git-scribe is an authors toolkit for writing and publishing books"
+  s.homepage          = "http://github.com/schacon/git-scribe"
+  s.email             = "schacon@gmail.com"
+  s.authors           = [ "Scott Chacon" ]
+  s.has_rdoc          = false
+
+  s.files             = files
+
+  s.executables       = %w( git-scribe )
+
+  s.description       = <<desc
+  git-scribe is a workflow tool for starting, writing, reviewing and publishing
+  multiple forms of a book.  it allows you to use asciidoc plain text markup to
+  write, review and translate a work and provides a simple toolkit for generating
+  common digital outputs for publishing - epub, mobi, pdf and html.  it is also
+  integrated into github functionality, letting you automate the publishing and
+  collaboration process.
+desc
+end

data/lib/git-scribe.rb

@@ -1,175 +1,39 @@
 require 'rubygems'
 require 'nokogiri'
 require 'liquid'
-require 'subcommand'
+
+require 'git-scribe/generate'
+require 'git-scribe/check'
+require 'git-scribe/init'
 
 require 'fileutils'
 require 'pp'
 
 class GitScribe
 
-  include Subcommands
+  include Init
+  include Check
+  include Generate
+
+  attr_accessor :subcommand, :args, :options
+  attr_reader :info
 
   BOOK_FILE = 'book.asc'
   OUTPUT_TYPES = ['pdf', 'epub', 'mobi', 'html', 'site']
   SCRIBE_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
   def initialize
-
+    @subcommand = nil
+    @args = []
     @options = {}
-    global_options do |opts|
-      opts.banner = "Usage: #{$0} [options] [subcommand [options]]"
-      opts.description = "git-scribe helps you write books with the power of Git"
-      opts.separator ""
-      opts.separator "Global options are:"
-      opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-        @options[:verbose] = v
-      end
-    end
-
-    command :init do |opts|
-      opts.banner = "Usage: git scribe init (directory)"
-      opts.description = "initialize a new book layout"
-      opts.on("-l", "--lang", "choose a default language (en)") do |v|
-        @options[:lang] = lang || 'en'
-      end
-    end
-
-    command :gen do |opts|
-      opts.banner = "Usage: git scribe gen [options]"
-      opts.description = "generate digital formats"
-    end
-
-    @command = opt_parse
-  end
-
-  def self.start
-    GitScribe.new.run
-  end
-
-  def run
-    if @command && self.respond_to?(@command)
-      self.send @command
-    else
-      help
-    end
   end
 
   ## COMMANDS ##
- 
 
   def die(message)
     raise message
   end
 
-  # start a new scribe directory with skeleton structure
-  def init
-    name = ARGV.shift
-    die("needs a directory name") if !name
-    die("directory already exists") if File.exists?(name)
-
-    puts "inititalizing #{name}"
-    from_stdir = File.join(SCRIBE_ROOT, 'template')
-    FileUtils.cp_r from_stdir, name
-  end
-
-  # check that we have everything needed
-  def check
-    # check for asciidoc
-    if !check_can_run('asciidoc')
-      puts "asciidoc is not present, please install it for anything to work"
-    else
-      puts "asciidoc - ok"
-    end
-
-    # check for xsltproc
-    if !check_can_run('xsltproc --version')
-      puts "xsltproc is not present, please install it for html generation"
-    else
-      puts "xsltproc - ok"
-    end
-
-    # check for a2x - should be installed with asciidoc, but you never know
-    if !check_can_run('a2x')
-      puts "a2x is not present, please install it for epub generation"
-    else
-      puts "a2x - ok"
-    end
-
-    # check for fop
-    if !check_can_run('fop -version')
-      puts "fop is not present, please install for PDF generation"
-    else
-      puts "fop - ok"
-    end
-  end
-
-  def check_can_run(command)
-    `#{command} 2>&1`
-    $?.exitstatus == 0
-  end
-  # generate the new media
-  def gen
-    type = ARGV.shift || 'all'
-    prepare_output_dir
-
-    gather_and_process
-
-    types = type == 'all' ? OUTPUT_TYPES : [type]
-
-    output = []
-    Dir.chdir("output") do
-      types.each do |out_type|
-        call = 'do_' + out_type
-        if self.respond_to? call
-          self.send call
-        else
-          puts "NOT A THING: #{call}"
-        end
-      end
-      # clean up
-      `rm #{BOOK_FILE}`
-    end
-  end
-
-  def prepare_output_dir
-    Dir.mkdir('output') rescue nil
-    Dir.chdir('output') do
-      Dir.mkdir('stylesheets') rescue nil
-      puts SCRIBE_ROOT
-      from_stdir = File.join(SCRIBE_ROOT, 'stylesheets')
-      pp from_stdir
-      FileUtils.cp_r from_stdir, '.'
-    end
-  end
-
-  def a2x(type)
-    "a2x -f #{type} -d book "
-  end
-
-  def a2x_wss(type)
-    a2x(type) + " --stylesheet=stylesheets/handbookish.css"
-  end
-
-  def do_pdf
-    puts "GENERATING PDF"
-    # TODO: syntax highlighting (fop?)
-    puts `asciidoc -b docbook #{BOOK_FILE}`
-    strparams = {'callout.graphics' => 0,
-                 'navig.graphics' => 0,
-                 'admon.textlabel' => 1,
-                 'admon.graphics' => 0}
-    param = strparams.map { |k, v| "--stringparam #{k} #{v}" }.join(' ')
-    puts cmd = "xsltproc  --nonet #{param} --output #{local('book.fo')} #{base('docbook-xsl/fo.xsl')} #{local('book.xml')}"
-    puts `#{cmd}`
-    cmd = "fop -fo #{local('book.fo')} -pdf #{local('book.pdf')}"
-    puts `#{cmd}`
-    #puts `#{a2x('pdf')} -v --fop #{BOOK_FILE}`
-    if $?.exitstatus == 0
-      'book.pdf'
-    end
-  end
-
   def local(file)
     File.expand_path(File.join(Dir.pwd, file))
   end
@@ -178,178 +42,20 @@ class GitScribe
     File.join(SCRIBE_ROOT, file)
   end
 
-  def do_epub
-    puts "GENERATING EPUB"
-    # TODO: look for custom stylesheets
-    `#{a2x_wss('epub')} -v #{BOOK_FILE}`
-    puts 'exit status', $?.exitstatus
-    'book.epub'
-  end
-
-  def do_html
-    puts "GENERATING HTML"
-    # TODO: look for custom stylesheets
-    #puts `#{a2x_wss('xhtml')} -v #{BOOK_FILE}`
-    styledir = local('stylesheets')
-    puts cmd = "asciidoc -a stylesdir=#{styledir} -a theme=handbookish #{BOOK_FILE}"
-    `#{cmd}`
-    puts 'exit status', $?.exitstatus
-    'book.html'
-  end
-
-  def do_site
-    puts "GENERATING SITE"
-    # TODO: check if html was already done
-    puts `asciidoc -b docbook #{BOOK_FILE}`
-    xsldir = base('docbook-xsl/xhtml')
-    `xsltproc --stringparam html.stylesheet stylesheets/handbookish.css --nonet #{xsldir}/chunk.xsl book.xml`
-
-    source = File.read('index.html')
-    html = Nokogiri::HTML.parse(source, nil, 'utf-8')
-
-    sections = []
-    c = -1
-
-    # each chapter
-    html.css('.toc > dl').each do |section|
-      section.children.each do |item|
-        if item.name == 'dt' # section
-          c += 1
-          sections[c] ||= {'number' => c}
-          link = item.css('a').first
-          sections[c]['title'] = title = link.text
-          sections[c]['href'] = href = link['href']
-          clean_title = title.downcase.gsub(/[^a-z0-9\-_]+/, '_') + '.html'
-          sections[c]['link'] = clean_title
-          if href[0, 10] == 'index.html'
-            sections[c]['link'] = 'title.html'
-          end
-          sections[c]['sub'] = []
-        end
-        if item.name == 'dd' # subsection
-          item.css('dt').each do |sub|
-            link = sub.css('a').first
-            data = {}
-            data['title'] = title = link.text
-            data['href'] = href = link['href']
-            data['link'] = sections[c]['link'] + '#' + href.split('#').last
-            sections[c]['sub'] << data
-          end
-        end
-      end
-      puts
-    end
-
-    pp sections
-
-    book_title = html.css('head > title').text
-    content = html.css('body > div')[1]
-    content.css('.toc').first.remove
-    content = content.inner_html
-
-    puts content 
-    sections.each do |s|
-      content.gsub!(s['href'], s['link'])
-    end
-
-    template_dir = File.join(SCRIBE_ROOT, 'site', 'default')
-
-    # copy the template files in
-    files = Dir.glob(template_dir + '/*')
-    FileUtils.cp_r files, '.'
-
-    Liquid::Template.file_system = Liquid::LocalFileSystem.new(template_dir)
-    index_template = Liquid::Template.parse(File.read(File.join(template_dir, 'index.html')))
-    page_template = Liquid::Template.parse(File.read(File.join(template_dir, 'page.html')))
-
-    # write the index page
-    main_data = { 
-      'book_title' => book_title,
-      'sections' => sections
-    }
-    File.open('index.html', 'w+') do |f|
-      f.puts index_template.render( main_data )
-    end
-
-    # write the title page
-    File.open('title.html', 'w+') do |f|
-      data = { 
-        'title' => sections.first['title'],
-        'sub' => sections.first['sub'],
-        'prev' => {'link' => 'index.html', 'title' => "Main"},
-        'home' => {'link' => 'index.html', 'title' => "Home"},
-        'next' => sections[1],
-        'content' => content
-      }
-      data.merge!(main_data)
-      f.puts page_template.render( data )
-    end
-
-    # write the other pages
-    sections.each_with_index do |section, i|
-
-      if i > 0 # skip title page
-        source = File.read(section['href'])
-        html = Nokogiri::HTML.parse(source, nil, 'utf-8')
-
-        content = html.css('body > div')[1].to_html
-        sections.each do |s|
-          content.gsub!(s['href'], s['link'])
-        end
-
-        File.open(section['link'], 'w+') do |f|
-          next_section = nil
-          if i <= sections.size
-            next_section = sections[i+1]
-          end
-          data = { 
-            'title' => section['title'],
-            'sub' => section['sub'],
-            'prev' => sections[i-1],
-            'home' => {'link' => 'index.html', 'title' => "Home"},
-            'next' => next_section,
-            'content' => content
-          }
-          data.merge!(main_data)
-          f.puts page_template.render( data )
-        end
-        #File.unlink(section['href'])
-
-        puts i
-        puts section['title']
-        puts section['href']
-        puts section['link']
-        puts
-      end
-
-      #File.unlink
-    end
-  end
-
-
-  # create a new file by concatenating all the ones we find
-  def gather_and_process
-    files = Dir.glob("book/*")
-    FileUtils.cp_r files, 'output'
-  end
-
-  # DISPLAY HELPER FUNCTIONS #
+  # API/DATA HELPER FUNCTIONS #
 
-  def l(info, size)
-    clean(info)[0, size].ljust(size)
+  def git(subcommand)
+    `git #{subcommand}`.chomp
   end
 
-  def r(info, size)
-    clean(info)[0, size].rjust(size)
+  def first_arg(args)
+    Array(args).shift
   end
 
-  def clean(info)
-    info.to_s.gsub("\n", ' ')
+  # eventually we'll want to log this or have it retrievable elsehow
+  def info(message)
+    @info ||= []
+    @info << message
   end
 
-  # API/DATA HELPER FUNCTIONS #
-
-  def git(command)
-    `git #{command}`.chomp
-  end
 end