kindlerb 0.1.1 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cab5c3ffc932e8c475b229d29b77fcd403cedc0
+  data.tar.gz: 55c0bceb12bb7e190b65ce1a2450229c5fb2ff55
+SHA512:
+  metadata.gz: 45f6cad989b027854eaa0f788f3290f2749ec206bd785917cc1c79c77d1a58499a9d6727fcd4236801573ef83ee8cb8b8e021aee3b3c258fe6fa733476a3bc0f
+  data.tar.gz: a2124e7d8f7ebc1dcb2765ecd95addfa6b0b64bd52ca830a66e528001c306d91cadc90faf0390c6ae2aca0b520235c1520332ea0bd4c5aff58a28b97d5635e05

data/.gitignore

@@ -1 +1 @@
-testtree/
+testtree/

data/Gemfile

@@ -1,3 +1,3 @@
-
-gem 'nokogiri'
-gem 'mustache'
+
+gem 'nokogiri'
+gem 'mustache'

data/MIT-LICENSE.txt

@@ -1,21 +1,21 @@
-Copyright (c) 2010 Daniel Choi, http://danielchoi.com/software/
-
-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.
-
+Copyright (c) 2010 Daniel Choi, http://danielchoi.com/software/
+
+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.markdown → README.md}

@@ -1,111 +1,139 @@
-# kindlerb
-
-kindlerb is a Ruby Kindle periodical-format ebook generator. I extracted
-this tool from [kindlefeeder.com][kf1]. I also built [Kindlefodder][kf2] on
-top of kindlerb.
-
-[kf1]:http://kindlefeeder.com
-[kf2]:https://github.com/danchoi/kindlefodder
-
-kindlerb converts a file tree of sections, articles, images, and metadata into
-a MOBI periodical-formatted document for the Kindle. It is a wrapper around the
-`kindlegen` program from Amazon that hides the details for templating OPF and NCX
-files.
-
-## Requirements
-
-* Ruby 1.9.x. 
-* Make sure kindlegen is on your PATH.
-
-You can get kindlegen [here][kindlegen].
-
-[kindlegen]:http://www.amazon.com/gp/feature.html?docId=1000234621
-
-## Install
-
-    gem install kindlerb
-
-## How to use it 
-
-Run the program at the root of the file tree:
-
-    kindlerb [filetree dir]
-
-The output will be a mobi document.
-
-The file tree input structure is 
-
-    _document.yml
-    sections/
-      000/
-        _section.txt # contains section title
-        000.html # an article
-        001.html 
-      001/
-        _section.txt 
-        000.html
-        001.html 
-        002.html
-
-kindlerb will extract article titles from the `<title>` (in `<head>`) tag in
-the *.html files .
-
-The _document.yml is a YAML document. It should look like something like this:
-
-    --- 
-    doc_uuid: kindlerb.21395-2011-12-19
-    title: my-ebook
-    author: my-ebook
-    publisher: me
-    subject: News
-    date: "2011-12-19"
-    masthead: /home/choi/Desktop/masthead.gif
-    cover: /home/choi/Desktop/cover.gif
-    mobi_outfile: my-ebook.mobi
-
-kindlerb uses the the file tree and _document.yml to construct these additional
-resource required by Amazon's `kindlegen` program:
-
-* nav-contents.ncx 
-* contents.html
-* kindlerb.opf
-
-After that, kindlerb will exec the kindlegen program to generate your mobi
-document.  The filename the output document is specified by the 'mobi_outfile'
-value in _document.yml.
-
-## Images
-
-kindlerb will incorporate images into the generated ebook by parsing all the
-`src` attributes of all the `<img>` tags in your *.html files.
-
-The `src` attributes must point to image files on the local filesystem. If the
-paths are relative, they should be relative to the target file tree root. 
-
-
-## Encoding
-
-Make sure all your textual source files are encoded in UTF-8.
-
-
-## Author 
-
-Daniel Choi 
-
-* email: dhchoi@gmail.com
-* github: [danchoi][github]
-* twitter: @danchoi
-
-[github]:http://github.com/danchoi
-
-
-I'm indebted to [mhl][mhl] for writing the
-[guardian-for-kindle][guardian-for-kindle] MOBI generator in Python. kindlerb
-ported a bunch of ideas from that project over to Ruby.
-
-[mhl]:https://github.com/mhl
-[guardian-for-kindle]:https://github.com/mhl/guardian-for-kindle
-
-
-
-
+# kindlerb
+
+kindlerb is a Ruby Kindle periodical-format ebook generator. This tool was initially extracted from
+[kindlefeeder.com][kf1]. [Kindlefodder][kf2] was also built on
+top of kindlerb.
+
+[kf1]:http://kindlefeeder.com
+[kf2]:https://github.com/danchoi/kindlefodder
+
+kindlerb converts a file tree of sections, articles, images, and metadata into
+a MOBI periodical-formatted document for the Kindle. It is a wrapper around the
+`kindlegen` program from Amazon that hides the details for templating OPF and NCX
+files.
+
+## Requirements
+
+* Ruby 1.9.x. 
+
+## Installation and Setup
+
+Add `gem 'kindlerb', github: 'danchoi/kindlerb'` to your Gemfile then run
+```
+bundle install
+bundle binstubs kindlerb
+```
+Then **cd** into your app root and then run the below command - this will install the required Kindlegen package:
+`./bin/setupkindlerb`
+
+You're good to go!
+    
+**OR**
+
+run `gem install kindlerb`
+
+Then **cd** into your app root and then run the below command - this will install the required Kindlegen package:
+`setupkindlerb`
+
+You're good to go!
+
+## How to use it 
+
+Require kindlerb in your project.
+
+    require 'kindlerb'
+
+### Kindlerb.run(target_dir, verbose, compression_method)
+
+Only the first argument is mandatory, everything else will use default values if no arguments are provided.
+
+**target_dir** = Put the directory that contains your ebook files
+
+**verbose** = true or false. Default is false.
+
+**compression_method** = 'c0' (no compression) OR 'c1' (standard DOC compression) OR 'c2' (Kindle huffdic compression). Default is 'c2'.
+
+The output will be a mobi document.
+
+**target_dir** should include the below files and structure: 
+
+    _document.yml
+    sections/
+      000/
+        _section.txt # contains section title
+        000.html # an article
+        001.html 
+      001/
+        _section.txt 
+        000.html
+        001.html 
+        002.html
+
+kindlerb will extract article titles from the `<title>` (in `<head>`) tag in
+the *.html files .
+
+The _document.yml is a YAML document. It should look like something like this:
+
+    --- 
+    doc_uuid: kindlerb.21395-2011-12-19
+    title: my-ebook
+    author: my-ebook
+    publisher: me
+    subject: News
+    date: "2011-12-19"
+    masthead: /home/choi/Desktop/masthead.gif
+    cover: /home/choi/Desktop/cover.gif
+    mobi_outfile: my-ebook.mobi
+
+kindlerb uses the the file tree and _document.yml to construct these additional
+resource required by Amazon's `kindlegen` program:
+
+* nav-contents.ncx 
+* contents.html
+* kindlerb.opf
+
+After that, kindlerb will exec the kindlegen program to generate your mobi
+document.  The filename the output document is specified by the 'mobi_outfile'
+value in _document.yml.
+
+### Kindlerb.executable
+Will return the full path to the Kindlegen executable file.
+
+### Kindlerb.download
+This is called when you first install the gem and call `setupkindlerb` executable. It downloads the appropriate Kindlegen version for the host OS. There should be no need to call this after initial set up.
+
+## Images
+
+kindlerb will incorporate images into the generated ebook by parsing all the
+`src` attributes of all the `<img>` tags in your *.html files.
+
+The `src` attributes must point to image files on the local filesystem. If the
+paths are relative, they should be relative to the target file tree root. 
+
+
+## Encoding
+
+Make sure all your textual source files are encoded in UTF-8.
+
+
+## Authors
+
+**Daniel Choi**
+* email: dhchoi@gmail.com
+* github: [danchoi][github]
+* twitter: @danchoi
+[github]:http://github.com/danchoi
+
+**Emir Aydin**
+* email: emir@emiraydin.com
+* github: [emiraydin][github]
+* twitter: @emiraydin
+[github]:http://github.com/emiraydin
+
+
+Indebted to [mhl][mhl] for writing the
+[guardian-for-kindle][guardian-for-kindle] MOBI generator in Python. kindlerb
+ported a bunch of ideas from that project over to Ruby.
+
+[mhl]:https://github.com/mhl
+[guardian-for-kindle]:https://github.com/mhl/guardian-for-kindle

data/Rakefile

@@ -1,71 +1,71 @@
-require 'rake'
-require 'rake/testtask'
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
-
-desc "release and build and push new website"
-task :push => [:release, :web]
-
-desc "Bumps version number up one and git commits"
-task :bump do
-  basefile = "lib/vmail/version.rb"
-  file = File.read(basefile)
-  oldver = file[/VERSION = '(\d.\d.\d)'/, 1]
-  newver_i = oldver.gsub(".", '').to_i + 1
-  newver = ("%.3d" % newver_i).split(//).join('.')
-  puts oldver
-  puts newver
-  puts "Bumping version: #{oldver} => #{newver}"
-  newfile = file.gsub("VERSION = '#{oldver}'", "VERSION = '#{newver}'") 
-  File.open(basefile, 'w') {|f| f.write newfile}
-  `git commit -am 'Bump'`
-end
-
-
-desc "build and push website"
-task :web => :build_webpage do
-  puts "Building and pushing website"
-  Dir.chdir "../project-webpages" do
-    `scp out/vmail.html zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
-    `rsync -avz out/images-vmail zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
-    `rsync -avz out/stylesheets zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
-    `rsync -avz out/lightbox2 zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
-  end
-  `open http://danielchoi.com/software/vmail.html`
-end
-
-desc "build webpage"
-task :build_webpage do
-  `cp README.markdown ../project-webpages/src/vmail.README.markdown`
-  `cp coverage.markdown ../project-webpages/src/vmail.coverage.markdown`
-  Dir.chdir "../project-webpages" do
-    puts `ruby gen.rb vmail #{Vmail::VERSION}`
-    #`open out/vmail.html`
-  end
-end
-
-
-desc "git push and rake release bumped version"
-task :bumped do
-  puts `git push && rake release`
-  Rake::Task["web"].execute
-end
-
-desc "Run tests"
-task :test do 
-  $:.unshift File.expand_path("test")
-  require 'test_helper'
-  Dir.chdir("test") do 
-    Dir['*_test.rb'].each do |x|
-      puts "requiring #{x}"
-      require x
-    end
-  end
-
-  MiniTest::Unit.autorun
-end
-
-task :default => :test
-
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+
+desc "release and build and push new website"
+task :push => [:release, :web]
+
+desc "Bumps version number up one and git commits"
+task :bump do
+  basefile = "lib/vmail/version.rb"
+  file = File.read(basefile)
+  oldver = file[/VERSION = '(\d.\d.\d)'/, 1]
+  newver_i = oldver.gsub(".", '').to_i + 1
+  newver = ("%.3d" % newver_i).split(//).join('.')
+  puts oldver
+  puts newver
+  puts "Bumping version: #{oldver} => #{newver}"
+  newfile = file.gsub("VERSION = '#{oldver}'", "VERSION = '#{newver}'") 
+  File.open(basefile, 'w') {|f| f.write newfile}
+  `git commit -am 'Bump'`
+end
+
+
+desc "build and push website"
+task :web => :build_webpage do
+  puts "Building and pushing website"
+  Dir.chdir "../project-webpages" do
+    `scp out/vmail.html zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+    `rsync -avz out/images-vmail zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+    `rsync -avz out/stylesheets zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+    `rsync -avz out/lightbox2 zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+  end
+  `open http://danielchoi.com/software/vmail.html`
+end
+
+desc "build webpage"
+task :build_webpage do
+  `cp README.markdown ../project-webpages/src/vmail.README.markdown`
+  `cp coverage.markdown ../project-webpages/src/vmail.coverage.markdown`
+  Dir.chdir "../project-webpages" do
+    puts `ruby gen.rb vmail #{Vmail::VERSION}`
+    #`open out/vmail.html`
+  end
+end
+
+
+desc "git push and rake release bumped version"
+task :bumped do
+  puts `git push && rake release`
+  Rake::Task["web"].execute
+end
+
+desc "Run tests"
+task :test do 
+  $:.unshift File.expand_path("test")
+  require 'test_helper'
+  Dir.chdir("test") do 
+    Dir['*_test.rb'].each do |x|
+      puts "requiring #{x}"
+      require x
+    end
+  end
+
+  MiniTest::Unit.autorun
+end
+
+task :default => :test
+