RubyGems - epubforge - Versions diffs - 0.0.5 - Mend

epubforge 0.0.5

Files changed (83) hide show

data/Gemfile +26 -0
data/LICENSE.txt +20 -0
data/README.rdoc +26 -0
data/Rakefile +71 -0
data/VERSION +1 -0
data/bin/epubforge +10 -0
data/config/actions/book_to_epub.rb +20 -0
data/config/actions/generate.rb +24 -0
data/config/actions/generate_chapter.rb +26 -0
data/config/actions/git_backup.rb +23 -0
data/config/actions/gitify.rb +72 -0
data/config/actions/globals.rb +77 -0
data/config/actions/help.rb +21 -0
data/config/actions/init.rb +137 -0
data/config/actions/kindle.rb +68 -0
data/config/actions/notes_to_epub.rb +20 -0
data/config/actions/notes_to_kindle.rb +17 -0
data/config/actions/word_count.rb +126 -0
data/config/actions/wrap_scene_notes_in_hidden_div.rb +118 -0
data/config/htmlizers.rb +62 -0
data/lib/action/actions_lookup.rb +41 -0
data/lib/action/cli_command.rb +72 -0
data/lib/action/cli_sequence.rb +55 -0
data/lib/action/file_transformer.rb +59 -0
data/lib/action/run_description.rb +24 -0
data/lib/action/runner.rb +122 -0
data/lib/action/thor_action.rb +149 -0
data/lib/core_extensions/array.rb +5 -0
data/lib/core_extensions/kernel.rb +42 -0
data/lib/core_extensions/nil_class.rb +5 -0
data/lib/core_extensions/object.rb +5 -0
data/lib/core_extensions/string.rb +37 -0
data/lib/custom_helpers.rb +60 -0
data/lib/epub/assets/asset.rb +11 -0
data/lib/epub/assets/html.rb +8 -0
data/lib/epub/assets/image.rb +18 -0
data/lib/epub/assets/markdown.rb +8 -0
data/lib/epub/assets/page.rb +32 -0
data/lib/epub/assets/stylesheet.rb +22 -0
data/lib/epub/assets/textile.rb +8 -0
data/lib/epub/builder.rb +270 -0
data/lib/epub/packager.rb +16 -0
data/lib/epubforge.rb +97 -0
data/lib/errors.rb +8 -0
data/lib/project/project.rb +65 -0
data/lib/utils/action_loader.rb +7 -0
data/lib/utils/class_loader.rb +83 -0
data/lib/utils/directory_builder.rb +181 -0
data/lib/utils/downloader.rb +58 -0
data/lib/utils/file_orderer.rb +45 -0
data/lib/utils/file_path.rb +152 -0
data/lib/utils/html_translator.rb +99 -0
data/lib/utils/html_translator_queue.rb +70 -0
data/lib/utils/htmlizer.rb +92 -0
data/lib/utils/misc.rb +20 -0
data/lib/utils/root_path.rb +20 -0
data/lib/utils/settings.rb +146 -0
data/lib/utils/template_evaluator.rb +20 -0
data/templates/default/book/afterword.markdown.template +4 -0
data/templates/default/book/chapter-%i%.markdown.sequence +4 -0
data/templates/default/book/foreword.markdown.template +6 -0
data/templates/default/book/images/cover.png +0 -0
data/templates/default/book/stylesheets/stylesheet.css.template +2 -0
data/templates/default/book/title_page.markdown.template +4 -0
data/templates/default/notes/character.named.markdown.template +4 -0
data/templates/default/notes/stylesheets/stylesheet.css.template +2 -0
data/templates/default/payload.rb +65 -0
data/templates/default/settings/actions/local_action.rb.example +14 -0
data/templates/default/settings/config.rb.form +55 -0
data/templates/default/settings/htmlizers.rb +0 -0
data/templates/default/settings/wordcount.template +6 -0
data/test/helper.rb +22 -0
data/test/misc/config.rb +7 -0
data/test/sample_text/sample.markdown +30 -0
data/test/sample_text/sample.textile +24 -0
data/test/test_custom_helpers.rb +22 -0
data/test/test_directory_builder.rb +141 -0
data/test/test_epf_root.rb +9 -0
data/test/test_epubforge.rb +164 -0
data/test/test_htmlizers.rb +24 -0
data/test/test_runner.rb +15 -0
data/test/test_utils.rb +39 -0
metadata +328 -0

data/lib/epub/builder.rb ADDED Viewed

@@ -0,0 +1,270 @@
+# Avoiding namespace collision.
+XmlBuilder = Builder
+module EpubForge
+  module Epub
+    PAGE_FILE_EXTENSIONS  = %w(html markdown textile)
+    IMAGE_FILE_EXTENSIONS = %w(jpg png gif)
+    MEDIA_TYPES = { "gif" => "image/gif", "jpg" => "image/jpeg", "png" => "image/png",
+                    "css" => "text/css", "js" => "application/javascript", "pdf" => "application/pdf",
+                    "txt" => "text/plain", "xhtml" => "application/xhtml+xml"
+                  }
+    IMAGES_DIR = "".fwf_filepath.join( "/", "OEBPS", "Images" )
+    STYLE_DIR  = "".fwf_filepath.join( "/", "OEBPS", "Styles" )
+    TEXT_DIR   = "".fwf_filepath.join( "/", "OEBPS", "Text" )
+    class Builder
+      attr_reader :stylesheets
+      def initialize project, opts = {}
+        puts "--------------- forgin' #{project.filename_for_epub_book} ------------------"
+        @project = project
+        @config  = project.config
+        @book_dir_short = opts[:book_dir] ? opts[:book_dir].split.last.to_s : "book"
+        @book_dir = @project.target_dir.join( @book_dir_short ).fwf_filepath
+        @config = @project.config
+        @config["page_orderer"] = Utils::FileOrderer.new( opts[:page_order] || @config["pages"][@book_dir_short] )
+        @metadata = @config["metadata"] || {}
+        page_files = @book_dir.glob( ext: PAGE_FILE_EXTENSIONS )
+        @section_files = @config["page_orderer"].reorder( page_files )
+        @sections = @section_files.map do |section|
+          case section.to_s.split(".").last
+          when "markdown"
+            Assets::Markdown.new( section, @metadata, self )
+          when "html"
+            Assets::HTML.new( section, @metadata, self )
+          when "textile"
+            Assets::Textile.new( section, @metadata, self )
+          else
+            raise "UNKNOWN EXTENSION TYPE"
+          end
+        end
+        @sections.each_with_index{ |sec, i| sec.section_number = i }
+        images = @book_dir.glob( "images", ext: IMAGE_FILE_EXTENSIONS )
+        @images = images.map{ |img| Assets::Image.new(img) }
+        @stylesheets = @book_dir.glob( "stylesheets", "*.css" ).map do |sheet|
+          Assets::Stylesheet.new( sheet )
+        end
+        @scratch_dir = Dir.mktmpdir.fwf_filepath.join( "ebookdir" )
+      end
+      def toc
+        b = XmlBuilder::XmlMarkup.new(:indent => 2)
+        b.instruct!     # <?xml version="1.0" encoding="UTF-8"?>
+        b.declare! :DOCTYPE, :ncx, :PUBLIC, "-//NISO//DTD ncx 2005-1//EN", "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd" # <!DOCTYPE ncx PUBLIC "-//NISO//DTD ncx 2005-1//EN"
+        # <ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
+        b.ncx :xmlns => "http://www.daisy.org/z3986/2005/ncx/", :version => "2005-1" do
+          #     <head>
+          #         <meta name="dtb:uid" content="58cf98c8-e5be-416d-8ce8-ceae573d5ac5"/>
+          #         <meta name="dtb:depth" content="1"/>
+          #         <meta name="dtb:totalPageCount" content="0"/>
+          #         <meta name="dtb:maxPageNumber" content="0"/>
+          #     </head>
+          b.head do
+            b.meta :name => "dtb:uid", :content => "58cf98c8-e5be-416d-8ce8-ceae573d5ac5"
+            b.meta :name => "dtb:depth", :content => "1"
+            b.meta :name => "dtb:totalPageCount", :content => "0"
+            b.meta :name => "dtb:maxPageNumber", :content=> "0"
+          end
+          #     <docTitle>
+          #         <text>#{PROJECT_NAME}</text>
+          #     </docTitle>
+          b.docTitle do
+            b.text @metadata["name"]
+          end
+          #     <navMap>
+          b.navMap do
+            @sections.each_with_index do |section,i|
+              # <navPoint id="navPoint-#{i}" playOrder="#{i}">
+              #     <navLabel>
+              #         <text>#{section.title}</text>
+              #     </navLabel>
+              #     <content src="Text/section#{sprintf("%04i",i)}.xhtml"/>
+              # </navPoint>
+              b.navPoint :id => "navPoint-#{i}", :playOrder => "#{i}" do
+                b.navLabel do
+                  b.text section.title
+                end
+                b.content :src => section.link
+              end
+            end
+          end
+        end
+        b.target!.to_s
+      end
+      def mimetype
+        "application/epub+zip"
+      end
+      def container
+        b = XmlBuilder::XmlMarkup.new(:indent => 2)
+        # <?xml version="1.0"?>
+        b.instruct!
+        # <container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+        #     <rootfiles>
+        #         <rootfile full-path="OEBPS/content.opf" media-type="application/oebps-package+xml"/>
+        #    </rootfiles>
+        # </container>
+        b.container :version => "1.0", :xmlns => "urn:oasis:names:tc:opendocument:xmlns:container" do
+          b.rootfiles do
+            b.rootfile :"full-path" => "OEBPS/content.opf", :"media-type" => "application/oebps-package+xml"
+          end
+        end
+      end
+      def content_opf
+        b = XmlBuilder::XmlMarkup.new(:indent => 2)
+        # <?xml version="1.0" encoding="UTF-8"?>
+        b.instruct!
+        # <package xmlns="http://www.idpf.org/2007/opf" unique-identifier="BookID" version="2.0">
+        b.package :xmlns => "http://www.idpf.org/2007/opf", "unique-identifier" => "BookID", :version => "2.0" do
+          # <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
+          b.metadata :"xmlns:dc" => "http://purl.org/dc/elements/1.1/", :"xmlns:opf" => "http://www.idpf.org/2007/opf" do
+            #     <dc:title>#{PROJECT_NAME}</dc:title>
+            #     <dc:creator opf:role="aut">#{PROJECT_AUTHOR}</dc:creator>
+            #     <dc:language>en-US</dc:language>
+            #     <dc:identifier id="BookID" opf:scheme="UUID">urn:uuid:58cf98c8-e5be-416d-8ce8-ceae573d5ac5</dc:identifier>
+            #
+            #     <dc:rights>Creative Commons Non-commercial No Derivatives</dc:rights>
+            #     <dc:publisher>Lulu.com</dc:publisher>
+            #     <dc:date opf:event="original-publication">2012</dc:date>
+            #     <dc:date opf:event="epub-publication">2012</dc:date>
+            #
+            b.dc :title, @metadata["name"]
+            b.dc :creator, {:"opf:role" => "aut"}, @metadata["author"]
+            b.dc :language, "en-US"
+            b.dc :identifier, {:id => "BookID", "opf:scheme" => "UUID"}, "urn:uuid:58cf98c8-e5be-416d-8ce8-ceae573d5ac5"  #TODO Unique id generator
+            b.dc :rights, @metadata["license"]
+            b.dc :publisher, @metadata["publisher"] || "A Pack of Orangutans"
+            b.dc :date, {:"opf:event" => "original-publication"}, @metadata["original-publication"] || Time.now.year
+            b.dc :date, {:"opf:event" => "epub-publication"}, @metadata["epub-publication"] || Time.now.year
+          end
+          # <manifest>
+          b.manifest do
+            #     <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml"/>
+            b.item :id => "ncx", :href => "toc.ncx", :"media-type" => "application/x-dtbncx+xml"
+            @sections.each_with_index do |section, i|
+              b.item :id => section.link, :href => section.link, :"media-type" => section.media_type
+            end
+            @images.each do |image|
+              b.item :id => image.name, :href => image.link, :"media-type" => image.media_type
+            end
+            @stylesheets.each do |sheet|
+              b.item :id => sheet.name, :href => sheet.link, :"media-type" => sheet.media_type
+            end
+          end
+          # <spine toc="ncx">
+          b.spine :toc => "ncx" do
+            @sections.each_with_index do |section, i|
+              b.itemref :idref => "section#{sprintf("%04i",i)}.xhtml"
+            end
+          end
+          # TODO: <guide> section
+          # <guide>
+          #   <reference type="title-page" title="Title Page"
+          #            href="Text/title_page.xhtml" />
+          #   <reference type="cover" title="Cover" href="Text/cover.xhtml"/>
+          #   <reference type="text"       title="Text"
+          #            href="Text/chapter0001.xhtml" />
+          # </guide>
+        end
+        b.target!.to_s
+      end
+      # zips up contents
+      def build
+        Utils::DirectoryBuilder.create( @scratch_dir ) do |build|
+          build.file( "mimetype", mimetype )
+          build.dir( "META-INF" ) do
+            build.file("container.xml", container)
+          end
+          build.dir( "OEBPS" ) do
+            build.file( "toc.ncx", toc )
+            build.file( "content.opf", content_opf )
+            build.dir( "Text" ) do
+              @sections.each_with_index do |section, i|
+                build.file( "section#{sprintf("%04i",i)}.xhtml", wrap_page( section.html ) )
+              end
+            end
+            if @images.length > 0
+              build.dir "Images" do
+                for img in @images
+                  build.copy( img.filename )
+                end
+              end
+            end
+            unless @stylesheets.epf_blank?
+              build.dir "Styles" do
+                for sheet in @stylesheets
+                  build.file( sheet.name, sheet.contents )
+                end
+              end
+            end
+          end
+        end
+      end
+      def package epub_filename
+        Packager.new( @scratch_dir, epub_filename ).package
+      end
+      def clean
+        # `rm -r #{@scratch_dir}`
+      end
+      protected
+      def wrap_page content
+        b = XmlBuilder::XmlMarkup.new( :indent => 2)
+        b.instruct! :xml, :encoding => "utf-8", :standalone => "no"
+        b.declare! :DOCTYPE, :html, :PUBLIC, "-//W3C//DTD XHTML 1.1//EN", "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"
+        b.html :xmlns => "http://www.w3.org/1999/xhtml" do
+          b.head do
+            b.title( @metadata["name"] )
+            for sheet in @stylesheets
+              b.link :href => sheet.link, :media => "screen", :rel => "stylesheet", :type => "text/css"
+            end
+          end
+          b.body do
+            b << content
+          end
+        end
+        b.target!.to_s
+      end
+    end
+  end
+end

data/lib/epub/packager.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module EpubForge
+  module Epub
+    class Packager
+      def initialize( src_dir, dst_filename )
+        @src_dir = src_dir
+        @dst_filename = dst_filename
+      end
+      def package
+        @dst_filename = @dst_filename.expand
+        FileUtils.rm( @dst_filename ) if @dst_filename.exist?
+        `cd #{@src_dir} && zip -Xr #{@dst_filename.to_s.epf_backhashed_filename} mimetype META-INF OEBPS`
+      end
+    end
+  end
+end

data/lib/epubforge.rb ADDED Viewed

@@ -0,0 +1,97 @@
+# I don't know if mentioning them in the Gemfile automatically requires them.
+# Let's find out.
+# require 'readline'
+# require 'singleton'
+# require 'builder'
+require 'thor'
+require 'xdg'            # keep configuration files in sane places
+require 'debugger'
+require 'erb'
+require 'singleton'
+require 'builder'
+require 'pathname'
+require 'tmpdir'         # Dir.mktmpdir
+require 'net/http'
+require 'open-uri'            # needed by Utils::Downloader
+require 'yaml'
+require 'rbconfig'
+# require 'configurator'
+require 'fun_with_files'
+require 'fun_with_configurations'
+EpubForge = Module.new
+EpubForge::DEBUG = false
+# EpubForge.root responds with the gem directory
+FunWith::Files::RootPath.rootify( EpubForge, __FILE__.fwf_filepath.dirname.up )
+def debugger?
+  debugger if debugging?
+end
+def debugging?
+  EpubForge::DEBUG
+end
+require_relative 'core_extensions/array'
+require_relative 'core_extensions/kernel'
+require_relative 'core_extensions/nil_class'
+require_relative 'core_extensions/object'
+require_relative 'core_extensions/string'
+require_relative 'utils/directory_builder'
+require_relative 'utils/downloader'
+require_relative 'utils/file_orderer'
+require_relative 'utils/misc'
+require_relative 'utils/class_loader'
+require_relative 'utils/action_loader'
+require_relative 'utils/template_evaluator'
+module EpubForge
+  ACTIONS_DIR  = EpubForge.root.join( "config", "actions" )
+  TEMPLATES_DIR  = EpubForge.root.join( "templates" )
+  USER_SETTINGS = XDG['CONFIG_HOME'].to_s.fwf_filepath.join( "epubforge" )
+  USER_GLOBALS_FILE = USER_SETTINGS.join( "globals.rb" )
+  USER_ACTIONS_DIR  = USER_SETTINGS.join( "actions" )
+  puts "Warning:  Cannot create user settings folder." unless USER_ACTIONS_DIR.touch_dir
+  puts "Warning:  Cannot create globals file."         unless USER_GLOBALS_FILE.touch
+end
+EpubForge.install_fwc_config_from_file( EpubForge::USER_GLOBALS_FILE )
+EpubForge.config.activation_key = rand(20**32).to_s(16).gsub(/(.{5})/, '\1-')[0..-2]
+puts "Thank you for registering your copy of the epubforge gem.  Please write down your activation key (#{EpubForge.config.activation_key}) in case you need to call customer service."
+require_relative 'utils/html_translator'
+require_relative 'utils/html_translator_queue'
+require_relative 'utils/htmlizer'
+require_relative 'action/file_transformer'
+require_relative 'action/run_description'
+require_relative 'action/thor_action'
+require_relative 'action/actions_lookup'
+require_relative 'action/runner'
+require_relative 'action/cli_command'
+require_relative 'action/cli_sequence'
+require_relative 'custom_helpers'
+require_relative 'epub/builder'
+require_relative 'epub/packager'
+require_relative 'epub/assets/asset'
+require_relative 'epub/assets/page'
+require_relative 'epub/assets/html'
+require_relative 'epub/assets/markdown'
+require_relative 'epub/assets/textile'
+require_relative 'epub/assets/image'
+require_relative 'epub/assets/stylesheet'
+require_relative 'project/project'
+puts "Requirements loaded" if debugging?
+puts "Done with tests inside epubforge.rb" if debugging?

data/lib/errors.rb ADDED Viewed

@@ -0,0 +1,8 @@
+module EpubForge
+  module Exceptions
+    class NotAProject < Exception; end
+    class FileError < Exception; end
+    class FileDoesNotExist < FileError; end
+    class FileMustNotExist < FileError; end
+  end
+end

data/lib/project/project.rb ADDED Viewed

@@ -0,0 +1,65 @@
+module EpubForge
+  class Project
+    SETTINGS_FOLDER = "settings"
+    CONFIG_FILE_NAME = "config.rb"
+    PROJECT_ACTIONS_DIRECTORY = "actions"
+    attr_reader :target_dir, :config_file, :config, :book_dir,
+                :notes_dir, :project_basename, :filename_for_epub_book,
+                :filename_for_mobi_book, :filename_for_epub_notes,
+                :filename_for_mobi_notes, :actions_dir
+    def initialize( target_dir )
+      @target_dir = FunWith::Files::FilePath.new( target_dir ).expand
+      load_configuration
+      @notes_dir = config.notes_dir || @target_dir.join( "notes" )
+      @book_dir  = config.book_dir  || @target_dir.join( "book" )
+      @project_basename = default_project_basename
+      @filename_for_epub_book = @target_dir.join( "#{default_project_basename}.epub" )
+      @filename_for_mobi_book = @target_dir.join( "#{default_project_basename}.mobi" )
+      @filename_for_epub_notes = @target_dir.join( "#{default_project_basename}.notes.epub" )
+      @filename_for_mobi_notes = @target_dir.join( "#{default_project_basename}.notes.mobi" )
+    end
+    # shorthand string that 'names' the project, like the_vampire_of_the_leeky_hills.  Variable-ish, used within filenames
+    def default_project_basename
+      config.filename || @target_dir.basename.to_s.gsub( /\.epubforge$/ , '' )
+    end
+    # TODO: should test be more definitive?
+    def self.is_project_dir?( dir )
+      dir = dir && (dir.is_a?(String) || dir.is_a?(FunWith::Files::FilePath)) ? dir.fwf_filepath : nil
+      return false if dir.nil?
+      ( dir.exist? && dir.join( SETTINGS_FOLDER, CONFIG_FILE_NAME ).exist? && dir.join( "book" ).directory? ) ? dir : false
+    end
+    def project_exists?
+      @target_dir.exist? && config_file.exist?
+    end
+    def settings_folder(*args)
+      @settings_folder ||= @target_dir.join( SETTINGS_FOLDER )
+      @settings_folder.join( *args )
+    end
+    def config_file
+      settings_folder( CONFIG_FILE_NAME )
+    end
+    def actions_directory
+      settings_folder( ACTIONS_DIRECTORY )
+    end
+    def chapters
+      @book_dir.glob("chapter-????.*")
+    end
+    def load_configuration
+      self.install_fwc_config_from_file( config_file )
+    end
+  end
+end

data/lib/utils/action_loader.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module EpubForge
+  module Utils
+    class ActionLoader < ClassLoader
+      namespace( "EpubForge::Action" )
+    end
+  end
+end

data/lib/utils/class_loader.rb ADDED Viewed

@@ -0,0 +1,83 @@
+module EpubForge
+  module Utils
+    # filepath string with metadata, representing a class
+    # file that can be loaded.
+    class ClassLoader < FunWith::Files::FilePath
+      def self.loaded_classes
+        @loaded_classes ||= []
+      end
+      def self.loaded_directories
+        @loaded_directories ||= []
+      end
+      def self.namespace( nsp = nil )
+        @namespace = nsp unless nsp.nil?
+        @namespace
+      end
+      def class_name
+        unless @class_name
+          base = self.basename.to_s.split(".")[0].epf_camelize
+          @class_name = "#{self.class.namespace}::#{base}"
+        end
+        @class_name
+      end
+      # Returns true if an error was raised when trying to require the file,
+      # or if the expected class is not loaded after the file was required.
+      # Proper naming is very important here.
+      def require_me
+        begin
+          require self.to_s
+        rescue NameError => e
+          puts "Error encounterd while trying to load #{self.class_name} from #{self}"
+          puts e.message
+          puts e.backtrace.map{|line| "\t#{line}" }
+          return false
+        end
+        return self.class_loaded?
+      end
+      def class_loaded?
+        begin
+          self.to_class
+          return true
+        rescue NameError     # There's gotta be another way I should be doing this.
+          return false
+        end
+      end
+      def to_class
+        return @klass unless @klass.nil?
+        @klass = Utils::Misc.constantize( self.class_name )
+      end
+      def self.require_me( *loadables )
+        @loaded_classes ||= []
+        @loaded_directories ||= []
+        for loadable in loadables
+          loadable = self.new( loadable )
+          if loadable.file?
+            if loadable.require_me
+              @loaded_classes << loadable.to_class
+            else
+              puts "Warning: Failed to load #{loadable.class_name} from file #{loadable}"
+            end
+          elsif loadable.directory?
+            @loaded_directories << loadable
+            loadable.glob( "**", "*.rb" ).each do |entry|
+              self.require_me( entry )
+            end
+          else
+            puts "Warning: Could not find file #{loadable} to load htmlizers from."
+            raise "AAAH"
+          end
+        end
+      end
+    end
+  end
+end