maliq 0.0.7 → 0.0.8

data/README.md

@@ -26,7 +26,7 @@ Follow the steps below:
 
 2. Write meta data required for EPUB in the head of the file with Yaml Front Matter(YFM) form(see below).
 
-3. You can obtain separated xhtml files each of which represents a chapter from a markdown file if needed. This achive by placing a special marker into target line of your content. The Default marker is `<<<--- <filename> --->>>`. (ex. `<<<--- chapter02 --->>>`)
+3. You can obtain separated xhtml files each of which represents a chapter from a markdown file if needed. This achive by placing a special marker into target line of your content. The Default marker is `<<<--- <filename> --->>>` (ex. `<<<--- chapter02 --->>>`). When filenames  are omitted, system generate sequential names automatically for them.
 
 4. Place css and image files into the directory or its sub directory if any.
 

data/bin/maliq

@@ -4,31 +4,6 @@ require "trollop"
 
 class OptionParser
   def self.parse!
-    opts = build_opts
-
-    filenames = ARGV.select { |f| f.match /\.(md|markdown)$/ }
-    if filenames.empty?
-      abort "Must pass one or more markdown filenames to build xhtml output."
-    end
-    csses = Dir['*.css', '*/*.css']
-
-    lastname = nil
-    filenames.each_with_index do |fname, fno|
-      seq_name = Maliq::FileUtils.create_filename(lastname) if lastname && opts[:seq]
-      chapters = Maliq::FileUtils.split(fname)
-      chapters.each do |title, text|
-        title = seq_name.tap { |s| seq_name = seq_name.next } if !fno.zero? && opts[:seq]
-        dest = title.basename_with(:xhtml)
-        conv = Maliq::Converter.new(text, css:csses)
-        conv.set_meta(liquid:opts[:liquid]) if opts[:liquid]
-        conv.save(dest)
-        puts "'#{dest}' created."
-        lastname = title
-      end
-    end
-  end
-
-  def self.build_opts
     Trollop::options do
       version "Maliq #{Maliq::VERSION} (c) 2012 kyoendo"
       banner ~<<-EOS
@@ -62,8 +37,15 @@ class OptionParser
 
       opt :liquid, "Liquid plugin path", :type => :string
       opt :seq, "Build consecutive filenames", :default => false
+      opt :nav, "Create nav.xhtml(TOC)", :default => true
+      opt :toc, "Set title for TOC", :default => ''
     end
   end
 end
 
-OptionParser.parse!
+opts = OptionParser.parse!
+css = Dir['*.css', '*/*.css']
+opts.update(css: css)
+opts.update(toc:nil) if opts[:toc].empty?
+
+Maliq::Create.new(ARGV, opts).run!

data/bin/maliq_gepub

@@ -3,24 +3,6 @@
 require "maliq"
 require "trollop"
 require "gepub"
-require "stringio"
-
-# a patch for Nokogiri::XML::Node#namespaces
-# Hash[ alist ]  => Hash[ *alist.flatten ]
-class Nokogiri::XML::Node
-  def namespaces
-    Hash[*namespace_scopes.map { |nd|
-      key = ['xmlns', nd.prefix].compact.join(':')
-      if RUBY_VERSION >= '1.9' && document.encoding
-        begin
-          key.force_encoding document.encoding
-        rescue ArgumentError
-        end
-      end
-      [key, nd.href]
-    }.flatten]
-  end
-end
 
 class OptionParser
   class << self
@@ -90,12 +72,11 @@ class OptionParser
         cover_xhtml = create_cover_page(cover)
       end
 
-      xhtmls.map! { |f| xhtml_with_heading f }
+      navfile, xhtmls = pick_nav_file(xhtmls)
 
-      # Create Table of Contents page.
-      if opts[:toc] && no_nav_page?(xhtmls)
-        nav_xhtml = create_nav_page(xhtmls, css:csses)
-      end
+      heading_files = get_heading_files(navfile)
+
+      xhtmls.map! { |f| xhtml_with_heading f }
 
       GEPUB::Builder.new do
         metadata.each { |k, v| send k, *Array(v) }
@@ -110,14 +91,11 @@ class OptionParser
               heading 'Cover'
             end
 
-            if nav_xhtml
-              file 'nav.xhtml' => nav_xhtml
-              heading 'Table of Contents'
-            end
+            nav navfile if navfile
 
             xhtmls.each do |fname, head|
               file fname
-              heading head
+              heading head if !navfile || heading_files.include?(fname)
             end
           }
         }
@@ -129,22 +107,14 @@ class OptionParser
       StringIO.new(out)
     end
 
-    def no_nav_page?(xhtmls)
-      xhtmls.none? { |fname, _| File.basename(fname, '.*').match /(nav|toc)$/ }
+    def pick_nav_file(xhtmls)
+      navs, xhtmls = xhtmls.partition { |fname| fname.match /^(nav|toc)\.x*html$/ }
+      nav = navs.empty? ? nil : navs.first
+      return nav, xhtmls
     end
 
-    def create_nav_page(xhtmls, opts={})
-      out = Maliq::Converter.new(~<<-EOS, opts).run(:epub, 'xhtmls' => xhtmls)
-      ## Table of Contents
-
-      <ol id='toc'>
-        {% for ch in xhtmls %}
-          <li><a href='{{ ch[0] }}'>{{ ch[1] }}</a></li>
-        {% endfor %}
-      </ol>
-
-      EOS
-      StringIO.new(out)
+    def get_heading_files(navfile)
+      File.read(navfile).scan(/\w+\.xhtml(?=.*?<\/li>)/) if navfile
     end
 
     def xhtml_with_heading(xhtml)

data/lib/maliq.rb

@@ -1,5 +1,5 @@
 require "maliq/version"
 
 module Maliq
-  %w(system_extensions file_utils converter).each { |lib| require_relative 'maliq/' + lib }
+  %w(system_extensions file_utils converter create).each { |lib| require_relative 'maliq/' + lib }
 end

data/lib/maliq/create.rb

@@ -0,0 +1,79 @@
+# encoding: UTF-8
+# Maliq::Create receive markdown filename(s)
+# and create xhtml file(s).
+class Maliq::Create
+  def initialize(files, opts={})
+    @opts = opts
+    @nav = opts.delete(:toc) || opts.delete(:nav)
+    @mdfiles = get_markdown_files(files)
+  end
+
+  def get_markdown_files(files)
+    files.select { |f| f.match /\.(md|markdown)$/ }
+        .tap { |res|
+          if res.empty?
+            abort "Must pass one or more markdown filenames to build xhtml output."
+          end
+        }
+  end
+  private :get_markdown_files
+
+  def run!
+    lastname = nil
+    dirname = nil
+    nav_list = []
+    @mdfiles.each_with_index do |filename, fno|
+      dirname = File.dirname(filename)
+      if @opts[:seq] && lastname
+        seq_fname = Maliq::FileUtils.create_filename(lastname)
+      end
+
+      # Split a file at split markers to several chapters,
+      # each of which become a file.
+      chapters = Maliq::FileUtils.split(filename)
+
+      chapters.each do |fname, content|
+        #this change filenames with sequential names.
+        if @opts[:seq] && !fno.zero?
+          fname = seq_fname.tap { |s| seq_fname = seq_fname.next }
+        end
+
+        dest = File.join(dirname, fname.basename_with(:xhtml))
+        convert_and_save(content, dest)
+        nav_list << [fname, content]
+        lastname = fname
+      end
+    end
+    create_nav_page(nav_list, File.join(dirname, 'nav.xhtml')) if @nav
+  end
+
+  private
+  def convert_and_save(md_content, dest)
+    conv = Maliq::Converter.new(md_content, css:@opts[:css])
+    conv.set_meta(liquid:@opts[:liquid]) if @opts[:liquid]
+    conv.save(dest)
+  end
+
+  def create_nav_page(nav_list, dest)
+    nav_list.map! do |fname, content|
+      header = File.basename(fname, '.*').capitalize
+      content.match(/^\#{1,3}(.*)$/) { header = $1 } # find the first header
+      [fname.basename_with(:xhtml), header]
+    end
+
+    toc = @nav.is_a?(String) ? @nav : "##目次"
+
+    body = Maliq::Converter.new(~<<-EOS, @opts).run(:epub, 'list' => nav_list)
+    <nav epub:type="toc" id="toc">
+    #{toc}
+    <ol class='toc'>
+    {% for ch in list %}
+      <li><a href='{{ ch[0] }}'>{{ ch[1] }}</a></li>
+    {% endfor %}
+    </ol>
+    </nav>
+    EOS
+    body = body.gsub(/<p>(<nav.*?>)<\/p>/, '\1').gsub(/<p>(<\/nav>)<\/p>/, '\1')
+    File.write(dest, body)
+  end
+end

data/lib/maliq/version.rb

@@ -1,3 +1,3 @@
 module Maliq
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/create_spec.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe Maliq::Create do
+  before(:each) do
+    @header, @footer = ->lang='ja',title=nil{ ~<<-HEAD }, ~<<-FOOT
+      <?xml version="1.0" encoding="UTF-8"?>
+      <!DOCTYPE html>
+      <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="#{lang}">
+        <head>
+          <title>#{title}</title>
+          <link href='style.css' rel='stylesheet' type='text/css'/>
+        </head>
+        <body>
+      HEAD
+        </body>
+      </html>
+      FOOT
+  end
+
+  describe "#run" do
+    context "when pass one markdown file with a css" do
+      it 'returns one xhtml file with same filename' do
+        Dir.mktmpdir do |dir|
+          mdfile = "#{dir}/chap1.md"
+          cssfile = "#{dir}/style.css"
+          File.write(mdfile, ~<<-EOS)
+            ---
+            title: 'Sample'
+            ---
+            #title1
+            #title2
+            EOS
+          system 'touch', cssfile
+          Maliq::Create.new([mdfile], css:File.basename(cssfile)).run!
+          xhtml = "#{dir}/chap1.xhtml"
+          File.exist?(xhtml).should be_true
+          File.read(xhtml).should eql [@header.call('ja','Sample'), ~<<-EOS, @footer].join
+            <h1>title1</h1>
+
+            <h1>title2</h1>
+          EOS
+        end
+      end
+    end
+
+    context "when pass one markdown file in which split marker placed" do
+      it "returns two xhtml files" do
+        Dir.mktmpdir do |dir|
+          mdfile = "#{dir}/chap1.md"
+          cssfile = "#{dir}/style.css"
+          File.write(mdfile, ~<<-EOS)
+            ---
+            title: 'Sample'
+            ---
+            #title1
+            <<<------>>>
+            #title2
+            EOS
+          system 'touch', cssfile
+          Maliq::Create.new([mdfile], css:File.basename(cssfile)).run!
+          xhtml1, xhtml2 = "#{dir}/chap1.xhtml", "#{dir}/chap2.xhtml"
+          File.exist?(xhtml1).should be_true
+          File.exist?(xhtml2).should be_true
+          File.read(xhtml1).should eql [@header.call('ja','Sample'), ~<<-EOS, @footer].join
+            <h1>title1</h1>
+          EOS
+          File.read(xhtml2).should eql [@header.call('ja','Sample'), ~<<-EOS, @footer].join
+            <h1>title2</h1>
+          EOS
+        end
+      end
+    end
+
+    context "when nav option is true" do
+      it "also create nav.xhtml" do
+        Dir.mktmpdir do |dir|
+          mdfile = "#{dir}/chap1.md"
+          cssfile = "#{dir}/style.css"
+          File.write(mdfile, ~<<-EOS)
+            ---
+            title: 'Sample'
+            ---
+            #title1
+            <<<------>>>
+            #title2
+            EOS
+          system 'touch', cssfile
+          Maliq::Create.new([mdfile], css:File.basename(cssfile), nav:true).run!
+          nav = "#{dir}/nav.xhtml"
+          File.exist?(nav).should be_true
+          File.read(nav).should eql [@header.call, ~<<-EOS, @footer].join
+            <nav epub:type="toc" id="toc">
+
+            <h2>目次</h2>
+
+            <ol class='toc'>
+
+              <li><a href='chap1.xhtml'>title1</a></li>
+
+              <li><a href='chap2.xhtml'>title2</a></li>
+
+            </ol>
+
+
+            </nav>
+            EOS
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maliq
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -109,11 +109,13 @@ files:
 - bin/maliq_gepub
 - lib/maliq.rb
 - lib/maliq/converter.rb
+- lib/maliq/create.rb
 - lib/maliq/file_utils.rb
 - lib/maliq/system_extensions.rb
 - lib/maliq/version.rb
 - maliq.gemspec
 - spec/converter_spec.rb
+- spec/create_spec.rb
 - spec/file_utils_spec.rb
 - spec/plugins/calc.rb
 - spec/spec_helper.rb
@@ -145,6 +147,7 @@ summary: Maliq is a markdown, liquid converter for EPUB's xhtml. It comes with t
   is a wrapper of gepub gem which is a EPUB generator.
 test_files:
 - spec/converter_spec.rb
+- spec/create_spec.rb
 - spec/file_utils_spec.rb
 - spec/plugins/calc.rb
 - spec/spec_helper.rb