git-scribe 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2007-2009 Scott Chacon
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.asc

@@ -0,0 +1,67 @@
+Git Scribe
+==========
+
+The git-scribe tool is a simple command line toolset to help you use Git, GitHub and Asciidoc
+to write e-books.  This provides tools for setting up the structure, collaborating with co-authors, doing technical and copy-editing, handling translations, taking errata, as well as publishing online, pdf, mobi (Kindle) and epub (iBooks, Nook) versions.
+
+The project is targeted for writing books of any length, but should also be usable for articles and stuff too, though for a while you'll have to just do it as a really short book.
+
+Features
+========
+
+Eventually, these are the feature goals for the project:
+
+* Easy: Syntax-Highlighted Code, Formula, Diagrams
+* Site Generation: Comment, Search, Permalinks
+* Pegging versions of the book to versions of the tool it documents
+* Technical and Copy editing workflow tools
+* Translation workflow tools
+* Selling (possibly): Kindle, iBooks, Lulu, Pledgie(?)
+
+The idea is that you use the tool to generate a known structure, write in asciidoc and let the tool handle everything else for you.  I want authors to be able to focus on writing and not have to worry about anything else.
+
+A good AsciiDoc cheat sheet: http://powerman.name/doc/asciidoc#_text
+
+Disclaimer
+==========
+
+This tool is a work in progress.  At the 1.0 release, this file will be totally up to date, but for now I may have documented some stuff that doesn't yet work.  Contact me personally if you are interested in working on it.
+
+Installing
+==========
+
+You can install git-scribe via RubyGems.
+
+    $ gem install git-scribe
+
+For local generation (evenutally pushing to GitHub will handle gen for you), it depends on a couple things like:
+
+* Ruby
+* asciidoc, a2x
+* xslt stuff
+* FOP for PDF gen
+
+Usage
+=====
+
+Initialize a new book with `init` (not yet completed).
+
+    $ git scribe init
+
+This will set up the outline for your book.  All the book content goes into the 'book' subdirectory with 'book.asc' as the starting point.  If you want to split the writing up into multiple files you can simply include them in the book.asc file.
+
+    $ git scribe gen [site|html|pdf|epub|mobi|all]
+
+Roadmap
+=======
+
+See the_dream.asc for what this file should look like eventually.
+
+Contributing
+============
+
+If you want to hack on this, fork it, improve it and send me a pull request.
+
+To get started using it, just clone it and call the ./bin/git-scribe script directly from either the `example` subdir or your own book directory.  If you add a feature, make sure it's included in the example subdirectory so I can test it out.
+
+

data/bin/git-scribe

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'git-scribe'
+
+GitScribe.start(ARGV)

data/lib/git-scribe.rb

@@ -0,0 +1,294 @@
+require 'rubygems'
+require 'nokogiri'
+require 'liquid'
+
+require 'fileutils'
+require 'pp'
+
+class GitScribe
+
+  SCRIBE_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+  def initialize(args)
+    @command = args.shift
+    @args = args
+  end
+
+  def self.start(args)
+    GitScribe.new(args).run
+  end
+
+  def run
+    if @command && self.respond_to?(@command)
+      self.send @command
+    else
+      help
+    end
+  end
+
+  ## COMMANDS ##
+ 
+  def help
+    puts "No command: #{@command}"
+    puts "TODO: tons of help"
+  end
+
+  # start a new scribe directory with skeleton structure
+  def init
+  end
+
+  # check that we have everything needed
+  def check
+    # look for a2x (asciidoc, latex, xsltproc)
+  end
+
+  BOOK_FILE = 'book.asc'
+
+  OUTPUT_TYPES = ['pdf', 'epub', 'mobi', 'html', 'site']
+
+  # generate the new media
+  def gen
+    type = @args.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}`
+      # TODO: open media (?)
+    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
+
+  def base(file)
+    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 #
+
+  def l(info, size)
+    clean(info)[0, size].ljust(size)
+  end
+
+  def r(info, size)
+    clean(info)[0, size].rjust(size)
+  end
+
+  def clean(info)
+    info.to_s.gsub("\n", ' ')
+  end
+
+  # API/DATA HELPER FUNCTIONS #
+
+  def git(command)
+    `git #{command}`.chomp
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: git-scribe
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Chacon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-15 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+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: 
+- git-scribe
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.asc
+- lib/git-scribe.rb
+- bin/git-scribe
+has_rdoc: true
+homepage: http://github.com/schacon/git-scribe
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: git-scribe is an authors toolkit for writing and publishing books
+test_files: []
+