docrails_kindle 0.0.1

data/README.markdown

@@ -0,0 +1,47 @@
+# docrails_kindle
+
+This gem lets you generate a Kindle version of the [Ruby on Rails Guides][railsguide] with 
+working section and article navigation.
+
+[railsguide]:http://guides.rubyonrails.org/
+
+## Install
+
+    gem install docrails_kindle
+
+## Prerequisistes
+
+Download [KindleGen 2][kindlegen] and put it on your PATH.
+
+[kindlegen]:http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621
+
+## How to use
+
+    gem install railsguides_kindle
+    git clone git@github.com:lifo/docrails.git
+    cd docrails/railties/guides
+    KINDLE=1 rake generate_guides
+    cd output/kindle
+    docrails_kindle
+    
+The output document will be called something like
+`rails-guide.2012-11-18.mobi`. Don't confuse it with the other mobi document
+that gets generated by `rake genereate_guides`, which looks like
+`ruby_on_rails_guides_16c5f48.mobi`.
+  
+You can transfer this mobi file to your Kindle.
+
+
+## Contribute
+
+This program is a rough prototype. Some internal links may not work. Other
+defects in the resulting ebook may exist. Please file issues.
+
+Also, if the `docsrails` team would like to incorporate this into their
+`rake` tasks code, please take and modify my code as you see fit.
+
+
+## Author
+
+Daniel Choi http://github.com/danchoi
+

data/Rakefile

@@ -0,0 +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
+

data/bin/docrails_kindle

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+# take toc.ncx
+
+require 'nokogiri'
+require 'fileutils'
+require 'yaml'
+require 'date'
+
+# Get html pages in document order
+
+html_pages = Nokogiri::XML(File.read("toc.ncx")).search("navMap//content[@src]").map {|c| c[:src]}.uniq
+
+frontmatter = []
+
+html_pages.delete_if {|x| 
+  # we need to treat frontmatter differently
+  if x =~ /(toc|welcome|credits|copyright).html/
+    frontmatter << x unless x =~ /toc/
+    true
+  end
+
+}
+
+puts "=> Making one section for all frontmatter."
+html = frontmatter.map {|x|
+  Nokogiri::HTML(File.open(x)).at("body").inner_html
+}.join("\n")
+
+fdoc = Nokogiri::HTML(html)
+
+# need to turn author h3's into h4's
+fdoc.search("h3").each { |h3|
+  if h3[:class] != 'section'
+    h3.name = 'h4'
+  else # add an id
+    h3['id'] = h3.inner_text.gsub(/\s/, '-')
+  end
+}
+fdoc.search("h2").each { |h2| 
+  h2.name = 'h3'
+  h2['id'] = h2.inner_text.gsub(/\s/, '-')
+}
+
+head = Nokogiri::XML::Node.new "head", fdoc
+title_node = Nokogiri::XML::Node.new "title", fdoc
+title_node.content = "Frontmatter"
+title_node.parent = head
+fdoc.at("body").before head
+File.open("frontmatter.html",'w'){|f| f.puts fdoc.to_html}
+
+html_pages.unshift "frontmatter.html"
+
+puts "=> Making one section folder per original HTML file"
+
+html_pages.each_with_index { |page, section_idx|
+  FileUtils::mkdir_p("sections/%03d" % section_idx)
+  doc = Nokogiri::HTML(File.open(page))
+  title = doc.at("title").inner_text.gsub("Ruby on Rails Guides: ", '')
+  title = page.capitalize.gsub('.html', '') if title.strip == ''
+  File.open("sections/%03d/_section.txt" % section_idx, 'w') {|f| f.puts title}
+  puts "sections/%03d -> #{title}" % section_idx
+  
+  # Fragment the page file into subsections
+  doc.xpath("//h3[@id]").each_with_index { |h3,item_idx|
+    subsection = h3.inner_text
+    content = h3.xpath("./following-sibling::*").take_while {|x| x.name != "h3"}.map {|x| x.to_html}
+    item = Nokogiri::HTML(h3.to_html + content.join("\n"))
+    item_path = "sections/%03d/%03d.html" % [section_idx, item_idx] 
+
+    # add head node and title node
+    head = Nokogiri::XML::Node.new "head", item
+    title_node = Nokogiri::XML::Node.new "title", item
+    title_node.content = subsection
+    title_node.parent = head
+    item.at("body").before head
+
+    # fix all image links
+    item.search("img").each { |img|
+      img['src'] = "#{Dir.pwd}/#{img['src']}"
+    }
+
+
+    File.open(item_path, 'w'){|f| f.puts item.to_html}
+    puts "  #{item_path} -> #{subsection}"
+
+  }
+}
+
+puts "=> Generating _document.yml"
+
+
+x = Nokogiri::XML(File.open("rails_guides.opf")).remove_namespaces!
+
+document = {
+  'doc_uuid' => x.at("package")['unique-identifier'],
+  'title' => x.at("title").inner_text,
+  'publisher' => x.at("publisher").inner_text,
+  'author' => x.at("creator").inner_text,
+  'subject' => x.at("subject").inner_text,
+  'date' => x.at("date").inner_text,
+  'cover' => x.at("item[@id=cover]")[:href],
+  'masthead' => x.at("item[@id=cover]")[:href],
+  'mobi_outfile' => "rails-guide.#{Date.today.to_s}.mobi"
+}
+puts document.inspect
+File.open("_document.yml", 'w'){|f| f.puts document.to_yaml}
+
+exec "kindlerb ."
+

data/docrails_kindle.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "docrails_kindle"
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.0'
+
+  s.authors     = ["Daniel Choi"]
+  s.email       = ["dhchoi@gmail.com"]
+  s.homepage    = "http://github.com/danchoi/docrails_kindle"
+  s.summary     = %q{Read Rails Guides for your Kindle}
+  s.description = %q{Read Rails Guides for your Kindle}
+
+  s.rubyforge_project = "docrails_kindle"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'kindlerb'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: docrails_kindle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &9708860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9708860
+- !ruby/object:Gem::Dependency
+  name: kindlerb
+  requirement: &9708360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9708360
+description: Read Rails Guides for your Kindle
+email:
+- dhchoi@gmail.com
+executables:
+- docrails_kindle
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- Rakefile
+- bin/docrails_kindle
+- docrails_kindle.gemspec
+- images/screen1-sm.gif
+- images/screen1.gif
+- mobi/rails-guide.2012-01-18.mobi
+homepage: http://github.com/danchoi/docrails_kindle
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: docrails_kindle
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Read Rails Guides for your Kindle
+test_files: []