pubgen 0.1.3 → 0.2.0

data/.gitignore

@@ -4,5 +4,5 @@ coverage
 doc
 pkg
 *.epub
-.rvmrc
+*.gem
 Gemfile.lock

data/README.md

@@ -1,7 +1,6 @@
 # Pubgen
 
-Pubgen is a command-line based epub generator. With a simple YAML, Pubgen make 
-a epub for you. 
+Pubgen is a command-line based epub generator. Make an epub with YAML.
 
 ## Installation
 
@@ -14,22 +13,26 @@ $ gem install pubgen
 
 ```bash
 $ pubgen -h
-pubgen, a epub generator. (http://github.com/9beach/pubgen)
+pubgen 0.2.0, an epub generator. (http://github.com/9beach/pubgen)
 
 Usage:
   pubgen <yaml file> [-o <epub file>] [-v]
   pubgen <yaml file> -m
+  pubgen -t <toc file> <epub root path>
 
-    -o, --output EPUB_PATH           Specify output epub file path
+    -o, --output EPUB_FILE           Specify output epub file path
     -m, --meta-file-only             Generate .opf, .ncx, mimetype, ...
+    -t, --toc TOC_FILE EPUB_ROOT     Print YAML using TOC file
     -v, --verbose                    Verbose output
 ```
 
 ## Quick Start
+
+### Create an epub
  
 Prepare files (documents, images, style sheets, etc.) that make up the 
-publication. iBooks requires strict xhtml. [`tidy -asxhtml`] 
-(http://tidy.sourceforge.net/) will be helpful.
+publication. Apple's iBooks requires strict xhtml. [`tidy -asxhtml`] 
+(http://tidy.sourceforge.net/) will be helpful to you.
 
 ```bash
 $ find .
@@ -45,7 +48,7 @@ $ find .
 ./style.css
 ```
 
-Create the utf-8 encoded YAML file describing the publication. As a example, 
+Create the utf-8 encoded YAML file describing the publication. As an example, 
 `will_oldham.yml`.
 
 ```yaml
@@ -71,7 +74,7 @@ metadata:
 # See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6
 #
 # If you provide cover-image without cover-page, pubgen automatically 
-# generate cover-page xhtml, and add it to manifest and spine
+# generate cover-page xhtml, and add it to manifest and spine.
 guide:
   toc-page:
   title-page: 
@@ -127,26 +130,40 @@ toc:
 Run pubgen.
 
 ```bash
-$ pubgen /path/to/will_oldham.yml -v
-mkdir .pubgen-4f4a210e
-cp ./contents/a.html .pubgen-4f4a210e/contents
-cp ./contents/b.html .pubgen-4f4a210e/contents
-cp ./images/cover.jpg .pubgen-4f4a210e/images
-cp ./images/1.jpg .pubgen-4f4a210e/images
-cp ./images/2.jpg .pubgen-4f4a210e/images
-cp ./images/3.jpg .pubgen-4f4a210e/images
-cp ./style.css .pubgen-4f4a210e/.
-cd .pubgen-4f4a210e
+$ pubgen <epub root>/will_oldham.yml -o out.epub
+zip > out.epub
+```
+
+Done!
+
+### Create meta files
+
+If you understand [Open Packaging Format 2.0.1] 
+(http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm) spec, and want to edit some 
+properties of the epub before packaging, you can try pubgen with 
+`--meta-file-only` option.
+
+```bash
+$ cd <epub root>
+$ pubgen will_oldham.yml -m
 cat > META-INF/container.xml
 cat > mimetype
 cat > cover-pubgen.xhtml
 cat > content.opf
 cat > toc.ncx
-zip > pubgen.epub
-cd /path/to/prev_dir
-mv .pubgen-4f4a210e/pubgen.epub 'Will Oldham_ Wikipedia, the free encyclopedia.epub'
-rm -rf .pubgen-4f4a210e
-# Successfully generated 'Will Oldham_ Wikipedia, the free encyclopedia.epub'
+# Edit content.opf/toc.ncx, and archive epub with zip command
+$ zip -r ../will_oldham.epub .
 ```
 
-Done!
+### Generate YAML using TOC file
+
+Pubgen generates a YAML using TOC file. Pubgen-generated YAML is not complete, 
+but is probably quite useful.
+
+```bash
+$ pubgen -t <epub root>/contents/toc.html <epub root> > out.yml
+$ vi out.yml # Open and complete YAML
+$ cp out.yml <epub root>
+$ pubgen <epub root>/out.yml -o out.epub
+zip > out.epub
+```

data/Rakefile

@@ -1,10 +1,85 @@
 require 'rake'
 require 'rake/testtask'
 
-task :default => [:test_units]
+task :default => [:test_bad_options]
+
 Rake::TestTask.new('test_units') do |t|
   t.libs << %w[lib test]
   t.pattern = 'test/test*.rb'
   t.warning = true
+  # t.verbose = true
+end
+
+def sh_echo_off(cmd)
+  %x[#{cmd}]
+  raise "Failed: #{cmd}" unless $?.success?
+end
+
+def sh_echo_off_failure(cmd)
+  %x[#{cmd} > /dev/null 2>&1]
+  raise "Not failed: #{cmd}" if $?.success?
+end
+
+$tmpdir = '.rake_test'
+
+task :test_bad_options => :test_toc_2 do |t|
+  $stdout << "# task: #{t} => "
+  sh_echo_off_failure("bin/pubgen -t x.html -o a.epub")
+  sh_echo_off_failure("bin/pubgen -t x.html -m")
+  sh_echo_off_failure("bin/pubgen -o x.epub -m")
+  sh_echo_off_failure("bin/pubgen")
+  sh_echo_off_failure("bin/pubgen -t x.html")
+  sh_echo_off_failure("bin/pubgen -o")
+  sh_echo_off_failure("bin/pubgen -t")
+  puts "done!"
+end
+
+task :test_toc_2 => :test_toc_1 do |t|
+  $stdout << "# task: #{t} => "
+  sh_echo_off("mkdir -p #{$tmpdir}")
+  sh_echo_off("cp test/toc_2/couchdb.html #{$tmpdir}")
+  sh_echo_off("touch #{$tmpdir}/foreword.html #{$tmpdir}/preface.html " << 
+    "#{$tmpdir}/why.html #{$tmpdir}/consistency.html #{$tmpdir}/tour.html " <<
+    "#{$tmpdir}/api.html")
+  o_yml = "#{$tmpdir}/.out.yml"
+  sh_echo_off("bin/pubgen -t #{$tmpdir}/couchdb.html #{$tmpdir} > #{o_yml}")
+  sh_echo_off("diff test/toc_2/couchdb.yml #{o_yml}")
+  sh_echo_off("rm -rf #{$tmpdir}")
+  puts "done!"
+end
+
+task :test_toc_1 => :test_output do |t|
+  $stdout << "# task: #{t} => "
+  sh_echo_off("mkdir -p #{$tmpdir}")
+  o_yml = "#{$tmpdir}/.out.yml"
+  sh_echo_off("bin/pubgen -t test/toc_1/will_oldham.html test/toc_1 > #{o_yml}")
+  sh_echo_off("diff test/toc_1/will_oldham.yml #{o_yml}")
+  sh_echo_off("rm -rf #{$tmpdir}")
+  puts "done!"
+end
+
+task :test_output => :test_units do |t|
+  $stdout << "# task: #{t} => "
+  sh_echo_off("mkdir -p #{$tmpdir}/contents")
+  sh_echo_off("mkdir -p #{$tmpdir}/images")
+  sh_echo_off("cp test/output/will_oldham.yml #{$tmpdir}")
+  sh_echo_off("touch #{$tmpdir}/contents/a.html #{$tmpdir}/contents/b.html " <<
+    "#{$tmpdir}/images/1.jpg #{$tmpdir}/images/2.jpg " <<
+    "#{$tmpdir}/images/3.jpg #{$tmpdir}/images/cover.jpg " <<
+    "#{$tmpdir}/style.css")
+  sh_echo_off("bin/pubgen #{$tmpdir}/will_oldham.yml -o #{$tmpdir}/a.epub " <<
+    "> /dev/null")
+  sh_echo_off("rm -rf #{$tmpdir}")
+  puts "done!"
+end
+
+task :build_gem do
+  sh "gem build pubgen.gemspec"
+end
+
+task :push_gem => :build_gem do
+  $:.push File.expand_path("../lib", __FILE__)
+  require "pubgen/version"
+  sh "gem push pubgen-#{Pubgen::VERSION}.gem"
 end
 

data/bin/pubgen

@@ -9,63 +9,92 @@ require 'zipruby'
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'pubgen'
 
-HELP = <<EOF
-pubgen #{Pubgen::VERSION}, a epub generator. (http://github.com/9beach/pubgen)
+# just for one line log
+def pubgen_log(log, verbose = true)
+  $stdout << log << "\n" if verbose
+end
+
+def pubgen_err(err)
+  $stderr << '# ' << err << "\n"
+end
+
+help = <<EOF
+pubgen #{Pubgen::VERSION}, an epub generator. (http://github.com/9beach/pubgen)
 
 Usage:
   pubgen <yaml file> [-o <epub file>] [-v]
   pubgen <yaml file> -m
+  pubgen -t <toc file> <epub root path>
 
 EOF
 
 options = {}
 opts = OptionParser.new do |opts|
-  opts.banner = HELP
+  opts.banner = help
 
-  opts.on('-o', '--output EPUB_PATH', 'Specify output epub file path') do |epub_path|
-    options[:epub_path] = epub_path
+  opts.on('-o', '--output EPUB_FILE', 'Specify output epub file path') do |o|
+    options[:epub_path] = o
   end
-
-  opts.on('-m', '--meta-file-only', 'Generate .opf, .ncx, mimetype, ...') do |m|
-    options[:meta_file_only] = m
+  opts.on('-m', '--meta-file-only', 'Generate .opf, .ncx, mimetype, ...') do |o|
+    options[:meta_file_only] = o
   end
-
-  opts.on('-v', '--verbose', 'Verbose output') do |v|
-    options[:verbose] = v
+  opts.on('-t', '--toc TOC_FILE EPUB_ROOT', 'Print YAML using TOC file') do |o|
+    options[:toc_path] = o
+  end
+  opts.on('-v', '--verbose', 'Verbose output') do |o|
+    options[:verbose] = o
   end
 end
 opts.parse!(ARGV)
 
 # check options validity
-if (options[:meta_file_only] == true && options[:epub_path] != nil)
-  $stderr << <<EOF
-pubgen: `--meta-file-only' with `--output EPUB_PATH', not allowed
-
-Try `pubgen -h' for more informations
-EOF
+option_count = 0
+option_count += 1 if options[:meta_file_only] == true
+option_count += 1 if options[:epub_path] != nil
+option_count += 1 if options[:toc_path] != nil
+
+if option_count > 1
+  $stderr << "pubgen: `--meta-file-only', `--output' and `--toc' " << 
+             "options cannot be combined\n\n" <<
+             "Try `pubgen -h' for more informations\n"
   exit 1
 end
 
 if ARGV.size != 1
-  $stderr << <<EOF
-pubgen: specify a yaml file
-
-Try `pubgen -h' for more informations
-EOF
+  if options[:toc_path] != nil
+    $stderr << "pubgen: specify a epub root path\n\n" << 
+               "Try `pubgen -h' for more informations\n"
+  else
+    $stderr << "pubgen: specify a yaml file\n\n" << 
+               "Try `pubgen -h' for more informations\n"
+  end
   exit 1
-else
-  options[:yaml_path] = ARGV[0]
 end
+ 
+# `--toc' option. process it and exit
+if options[:toc_path] != nil
+  options[:epub_root] = ARGV[0]
+  begin
+    $stdout << Pubgen::YAML.generate(options[:epub_root], options[:toc_path])
+  rescue Exception=>e
+    pubgen_err(e.to_s)
+    exit 1
+  end
+  exit 0
+end
+
+# now, options[:toc_path] == nil
+options[:yaml_path] = ARGV[0]
 
 begin
   yaml = YAML::load File.open(options[:yaml_path])
 rescue Exception=>e
-  pubgen_err("While loading yaml: " + e.to_s)
+  pubgen_err("While loading yaml: " << e.to_s)
   exit 1
 end
 
 if yaml['metadata']['title'] == nil
-  pubgen_err("Failed to find the value of 'title' attribute in: " + 
+  pubgen_err("Failed to get the value of `title' attribute in: " << 
              options[:yaml_path])
   exit 1
 end
@@ -77,15 +106,6 @@ if !options[:meta_file_only] && !options[:epub_path]
 end
 # options done
 
-# just for one line log
-def pubgen_log(log, verbose = true)
-  $stdout << log + "\n" if verbose
-end
-
-def pubgen_err(err)
-  $stderr << '# ' + err + "\n"
-end
-
 if yaml['metadata']['creator'] == nil
   yaml['metadata']['creator'] = "pubgen-#{Pubgen::VERSION}" 
 end
@@ -102,35 +122,35 @@ begin
     # temporal working directory
     $tmpdir = ".pubgen-%08x" % Time.now.to_i 
     Dir.mkdir($tmpdir)
-    pubgen_log("mkdir " + $tmpdir, options[:verbose])
+    pubgen_log("mkdir " << $tmpdir, options[:verbose])
 
     # copy all the files of manifest to $tmpdir
     yaml['manifest'].each do |file|
       if Pubgen::OPF.valid_manifest_element?(file) == false
-        raise "Invalid manifest (not in sub-directory of yaml file): " + file
+        raise "Invalid manifest (not in sub-directory of yaml file): " << file
       end
-      target_dir = "#{$tmpdir}/#{File.dirname(file)}"
+      target_dir = "#{File.join($tmpdir, File.dirname(file))}"
       FileUtils.mkdir_p(target_dir)
-      FileUtils.cp("#{File.dirname(options[:yaml_path])}/#{file}", 
+      FileUtils.cp("#{File.join(File.dirname(options[:yaml_path]), file)}", 
                    target_dir, :verbose=>options[:verbose])
     end
 
     # change pwd
     Dir.chdir($tmpdir)
-    pubgen_log("cd " + $tmpdir, options[:verbose])
+    pubgen_log("cd " << $tmpdir, options[:verbose])
   end
 
   # generate container.xml 
   # it's path is fixed (META-INF/container.xml)
   Dir.mkdir('META-INF') if !File::directory?('META-INF')
-  container = File.new('META-INF/container.xml', 'w')
+  container = File.new(File.join('META-INF', 'container.xml'), 'w')
   container.write(Pubgen::Container.generate)
   container.close
-  pubgen_log('cat > META-INF/container.xml', 
+  pubgen_log("cat > #{File.join('META-INF', 'container.xml')}",
              options[:meta_file_only] || options[:verbose])
 
   # generate mimetype
-  # it's path is also fixed (./mimetype)
+  # it's path is also fixed (mimetype)
   mimetype = File.new('mimetype', 'w')
   mimetype.write('application/epub+zip')
   mimetype.close
@@ -143,7 +163,7 @@ begin
     cover_page = File.new(COVER_PAGE_PATH, 'w')
     cover_page.write(Pubgen::CoverPage.generate(yaml['guide']['cover-image']))
     cover_page.close
-    pubgen_log("cat > " + COVER_PAGE_PATH, 
+    pubgen_log("cat > " << COVER_PAGE_PATH, 
                options[:meta_file_only] || options[:verbose])
 
     # add/set it to manifest, spine, and cover-page
@@ -153,7 +173,7 @@ begin
   end
 
   # generate uuid
-  uuid = "%08x-" % Time.now.to_i + 
+  uuid = "%08x-" % Time.now.to_i << 
             [4,4,4,12].map {|l| "%0#{l}x" % rand(1 << l*4) }.join('-')
   # uuid = UUID.new.generate
 
@@ -161,7 +181,7 @@ begin
   opf = File.new(Pubgen::Container.opf_path, 'w')
   opf.write(Pubgen::OPF.generate(yaml, uuid))
   opf.close
-  pubgen_log("cat > " + Pubgen::Container.opf_path, 
+  pubgen_log("cat > " << Pubgen::Container.opf_path, 
              options[:meta_file_only] || options[:verbose])
   # pubgen automatically added .ncx file to opf's manifest
 
@@ -169,7 +189,7 @@ begin
   ncx = File.new(Pubgen::OPF.ncx_path, 'w')
   ncx.write(Pubgen::NCX.generate(yaml['metadata']['title'], yaml['toc'], uuid))
   ncx.close
-  pubgen_log("cat > " + Pubgen::OPF.ncx_path, 
+  pubgen_log("cat > " << Pubgen::OPF.ncx_path, 
              options[:meta_file_only] || options[:verbose])
 
   # make an epub
@@ -187,10 +207,10 @@ begin
 
     # mv pubgen.epub to options[:epub_path]
     Dir.chdir($pwd_old)
-    pubgen_log("cd " + $pwd_old, options[:verbose])
-    FileUtils.mv($tmpdir + "/pubgen.epub", options[:epub_path])
-    pubgen_log("mv #{$tmpdir}/pubgen.epub '#{options[:epub_path]}'", 
-               options[:verbose])
+    pubgen_log("cd " << $pwd_old, options[:verbose])
+    FileUtils.mv(File.join($tmpdir, 'pubgen.epub'), options[:epub_path])
+    pubgen_log("mv #{File.join($tmpdir, 'pubgen.epub')} " << 
+               "'#{options[:epub_path]}'", options[:verbose])
   end
 rescue Exception=>e
   $exit_code = 1
@@ -199,11 +219,11 @@ ensure
   # remove $tmpdir
   if Dir.pwd != $pwd_old
     Dir.chdir($pwd_old)
-    pubgen_log("cd " + $pwd_old, options[:verbose])
+    pubgen_log("cd " << $pwd_old, options[:verbose])
   end
   if File::directory?($tmpdir)
     FileUtils.rm_rf($tmpdir)
-    pubgen_log("rm -rf " + $tmpdir, options[:verbose])
+    pubgen_log("rm -rf " << $tmpdir, options[:verbose])
   end
 end
 

data/lib/pubgen.rb

@@ -3,3 +3,4 @@ require 'pubgen/ncx'
 require 'pubgen/opf'
 require 'pubgen/container'
 require 'pubgen/version'
+require 'pubgen/yaml'