git-scribe 0.0.4 → 0.0.5

data/lib/git-scribe/check.rb

@@ -0,0 +1,60 @@
+class GitScribe
+  module Check
+    # check that we have everything needed
+    def check(args = [])
+      status = {}
+
+      # check for git
+      if !check_can_run('git --version')
+        info "git is not present, please install it for anything to work"
+        status[:git] = true
+      else
+        info "git      - ok"
+        status[:git] = false
+      end
+
+      # check for asciidoc
+      if !check_can_run('asciidoc')
+        info "asciidoc is not present, please install it for anything to work"
+        status[:asciidoc] = true
+      else
+        info "asciidoc - ok"
+        status[:asciidoc] = false
+      end
+
+      # check for xsltproc
+      if !check_can_run('xsltproc --version')
+        info "xsltproc is not present, please install it for html generation"
+        status[:xsltproc] = true
+      else
+        info "xsltproc - ok"
+        status[:xsltproc] = false
+      end
+
+      # check for a2x - should be installed with asciidoc, but you never know
+      if !check_can_run('a2x')
+        info "a2x is not present, please install it for epub generation"
+        status[:a2x] = true
+      else
+        info "a2x      - ok"
+        status[:a2x] = false
+      end
+
+      # check for fop
+      if !check_can_run('fop -version')
+        info "fop is not present, please install for PDF generation"
+        status[:fop] = true
+      else
+        info "fop      - ok"
+        status[:fop] = false
+      end
+
+      status
+    end
+
+    def check_can_run(command)
+      `#{command} 2>&1`
+      $?.exitstatus == 0
+    end
+  end
+end

data/lib/git-scribe/cli.rb

@@ -0,0 +1,84 @@
+require 'subcommand'
+
+class GitScribe
+  include Subcommands
+
+  def info(message)
+    puts message
+  end
+
+  module CLI
+
+    def run
+      parse_options
+      if @subcommand && self.respond_to?(@subcommand)
+        begin
+          self.send @subcommand, @args
+        rescue Object => e
+          error e
+        end
+      else
+        help
+      end
+    end
+
+    def error(e)
+      puts 'Error: ' + e.to_s
+    end
+
+    def help
+      puts print_actions
+    end
+
+    def parse_options
+      @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 :check do |opts|
+        opts.banner = "Usage: git scribe check"
+        opts.description = "checks for system requirements for doc generation"
+      end
+
+      @subcommand = opt_parse
+      @args = ARGV
+    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
+
+  end
+
+  include CLI
+end

data/lib/git-scribe/generate.rb

@@ -0,0 +1,222 @@
+class GitScribe
+  module Generate
+    # generate the new media
+    def gen(args = [])
+      type = first_arg(args) || 'all'
+      prepare_output_dir
+
+      gather_and_process
+
+      types = type == 'all' ? OUTPUT_TYPES : [type]
+
+      ret = false
+      output = []
+      Dir.chdir("output") do
+        types.each do |out_type|
+          call = 'do_' + out_type
+          if self.respond_to? call
+            ret = self.send call
+          else
+            die "NOT A THING: #{call}"
+          end
+        end
+        # clean up
+        `rm #{BOOK_FILE}`
+        ret
+      end
+    end
+
+    def prepare_output_dir
+      Dir.mkdir('output') rescue nil
+      Dir.chdir('output') do
+        Dir.mkdir('stylesheets') rescue nil
+        from_stdir = File.join(SCRIBE_ROOT, 'stylesheets')
+        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
+      info "GENERATING PDF"
+      # TODO: syntax highlighting (fop?)
+      ex("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(' ')
+      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)
+      #puts `#{a2x('pdf')} -v --fop #{BOOK_FILE}`
+      if $?.exitstatus == 0
+        'book.pdf'
+      end
+    end
+
+    def do_epub
+      info "GENERATING EPUB"
+      # TODO: look for custom stylesheets
+      cmd = "#{a2x_wss('epub')} -v #{BOOK_FILE}"
+      if ex(cmd)
+        'book.epub'
+      end
+    end
+
+    def do_html
+      info "GENERATING HTML"
+      # TODO: look for custom stylesheets
+      #puts `#{a2x_wss('xhtml')} -v #{BOOK_FILE}`
+      styledir = local('stylesheets')
+      cmd = "asciidoc -a stylesdir=#{styledir} -a theme=handbookish #{BOOK_FILE}"
+      ex(cmd)
+      'book.html'
+    end
+
+    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")
+
+      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
+      end
+
+      book_title = html.css('head > title').text
+      content = html.css('body > div')[1]
+      content.css('.toc').first.remove
+      content = content.inner_html
+
+      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'])
+
+          info i
+          info section['title']
+          info section['href']
+          info section['link']
+        end
+
+        #File.unlink
+      end
+      sections
+    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
+
+    def ex(command)
+      out = `#{command} 2>&1`
+      info out
+      $?.exitstatus == 0
+    end
+
+  end
+end

data/lib/git-scribe/init.rb

@@ -0,0 +1,16 @@
+class GitScribe
+  module Init
+    # start a new scribe directory with skeleton structure
+    def init(args = [])
+      name = first_arg(args)
+      die("needs a directory name") if !name
+      die("directory already exists") if File.exists?(name)
+
+      info "inititalizing #{name}"
+      from_stdir = File.join(SCRIBE_ROOT, 'template')
+      ign = Dir.glob(from_stdir + '/.[a-z]*')
+      FileUtils.cp_r from_stdir, name
+      FileUtils.cp_r ign, name
+    end
+  end
+end

data/lib/git-scribe/version.rb

@@ -0,0 +1,3 @@
+class GitScribe
+  VERSION = '0.0.5'
+end

data/template/.gitignore

@@ -0,0 +1 @@
+output

data/template/.gitscribe

@@ -0,0 +1,5 @@
+---
+publish:  true
+edition:  0.1
+language: en
+version:  1.0

data/test/check_test.rb

@@ -0,0 +1,12 @@
+require File.expand_path "../test_helper", __FILE__
+
+context "scribe check tests" do
+  setup do
+    @scribe = GitScribe.new
+  end
+
+  test "scribe can check for programs it needs" do
+    status = @scribe.check
+    assert_equal status.size, 5
+  end
+end

data/test/gen_test.rb

@@ -0,0 +1,78 @@
+require File.expand_path "../test_helper", __FILE__
+
+context "scribe gen tests" do
+  setup do
+    @scribe = GitScribe.new
+  end
+
+  test "will not respond to non-thing" do
+    assert_raise RuntimeError do
+      @scribe.gen('mofo')
+    end
+  end
+
+  test "scribe can generate single page html" do
+    in_temp_dir do
+      @scribe.init('t')
+      Dir.chdir('t') do
+      file = @scribe.gen('html')
+        assert_equal 'book.html', file
+        out = Dir.glob('output/**/*')
+        assert out.include? 'output/book.html'
+        assert out.include? 'output/image'
+        assert out.include? 'output/stylesheets/handbookish.css'
+      end
+    end
+  end
+
+  test "scribe can generate site html" do
+    in_temp_dir do
+      @scribe.init('t')
+      Dir.chdir('t') do
+      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'
+      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')
+        assert_equal data, 'book.pdf'
+        out = Dir.glob('output/**/*')
+        assert out.include? 'output/book.pdf'
+      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'
+        out = Dir.glob('output/**/*')
+        assert out.include? 'output/book.epub'
+      end
+    end
+  end
+
+  xtest "scribe can generate docbook" do
+  end
+
+  xtest "scribe can generate a mobi" do
+  end
+
+  xtest "scribe can generate all" do
+  end
+
+  xtest "scribe doesn't regen already generated assets" do
+  end
+end