epubforge 0.0.10 → 0.0.11

data/lib/{action → epubforge/action}/cli_command.rb

@@ -27,7 +27,7 @@ module EpubForge
       protected
       def local_exec( cmd )
         cmd = (cmd == :undo ? @undo : @command)
-        return pseudo_success if cmd.epf_blank?
+        return pseudo_success if cmd.fwf_blank?
 
         execute_locally = @local_dir ? "cd #{@local_dir} && " : ""
         
@@ -39,7 +39,7 @@ module EpubForge
       
       def remote_exec( cmd )
         cmd = (cmd == :undo ? @undo : @command)
-        return pseudo_success if cmd.epf_blank?
+        return pseudo_success if cmd.fwf_blank?
 
         execute_remotely = (@remote_dir ? "cd #{@remote_dir} && " : "") + cmd
 

data/lib/{action → epubforge/action}/hooks_interface.rb

@@ -7,12 +7,12 @@ module EpubForge
       end
       
       def run_hooks( hookset )
-        super( hookset ) unless self == ThorAction
+        super( hookset ) unless self == Action
         
       end
         
       def self.included( base )
-        if base == ThorAction
+        if base == Action
           base.add_hook(:before) do
             @project = @options[:project]
           end

data/lib/{action → epubforge/action}/run_description.rb

@@ -5,7 +5,7 @@ module EpubForge
                     :project,
                     :namespace,
                     :subcommand,
-                    :klass,
+                    :action,
                     :errors,
                     :state,
                     :execution_returned
@@ -13,9 +13,7 @@ module EpubForge
       def initialize
         @args = nil
         @project = nil
-        @namepace = nil
-        @subcommand = nil
-        @klass = nil
+        @action = nil
         @errors = []
         @state = :initialized
       end
@@ -23,8 +21,12 @@ module EpubForge
       def run
         if self.runnable?
           handle_errors do
-            @args[0] = (@args[0]).split(":").last
-            @execution_returned = self.klass.start( @args )
+            puts "Run Description: #{@args.inspect}"
+            @args.shift if @args.first == self.action.keyword  # TODO: Remove this arg before getting here
+            
+            # If there is a project, it is sent to the action's execution as the first argument
+            @args.unshift( self.project ) if self.project
+            @execution_returned = self.action.run( *@args )
           end
         end
 
@@ -50,7 +52,8 @@ module EpubForge
         if self.errors?
           self.finish
           self.report_errors
-          exit( -1 )
+          
+          exit( -1 ) unless EpubForge.gem_test_mode?
         end
       end
       
@@ -59,7 +62,7 @@ module EpubForge
       end
       
       def errors?
-        !@errors.epf_blank?
+        !@errors.fwf_blank?
       end
       
       def success?
@@ -76,7 +79,7 @@ module EpubForge
       
       def to_s
         str = "RunDescription:\n"
-        [ :args, :project, :namespace, :subcommand, :klass, :errors, :state ].each do |data|
+        [ :args, :project, :action, :errors, :state ].each do |data|
           str << "#{data} : #{self.send(data).inspect}\n"
         end
 

data/lib/{action → epubforge/action}/runner.rb

@@ -14,18 +14,6 @@ module EpubForge
         @run_description = RunDescription.new
       end
       
-      def load_actions_dirs
-        ThorAction.actions_lookup.add_actions( EpubForge::ACTIONS_DIR )
-        ThorAction.actions_lookup.add_actions( EpubForge::USER_ACTIONS_DIR ) if EpubForge::USER_ACTIONS_DIR.directory?
-      end
-      
-      def load_project_machinery
-        if @run_description.project
-          ThorAction.actions_lookup.add_actions( @run_description.project.settings_folder( "actions" ) )
-          Utils::Htmlizer.instance.add_htmlizers( @run_description.project.settings_folder( "htmlizers.rb" ) )
-        end
-      end
-            
       def run
         @run_description.run
         @run_description
@@ -49,29 +37,33 @@ module EpubForge
 
       protected
       def parse_args
-        @args << "help" if @args.epf_blank?
+        @args << "help" if @args.fwf_blank?
         @run_description = RunDescription.new
         
+        # map_command_to_action                                 # if it's one of the default actions
         fetch_project
+        load_project_machinery
+
+        map_command_to_action # unless @run_description.action  # check for project-specific actions
+        
         @run_description.quit_on_errors
         
-        load_actions_dirs
-        load_project_machinery
         
-        map_command_to_klass
         
-        return false unless @run_description.klass
+        return false unless @run_description.action
 
-        if @run_description.project.nil? && @run_description.klass.project_required?
-          @run_description.errors << "Could not find a project directory, but the action #{@run_description.klass} requires one. Current directory is not an epubforge project."
+        if @run_description.project.nil? && @run_description.action.project_required?
+          @run_description.errors << "Could not find a project directory (current directory not a project, no project given as an argument), but the action #{@run_description.action} requires one."
         else
           @run_description.args = @args
         end
       end
       
-      def map_command_to_klass
-        @run_description.klass = ThorAction.command_to_action_classes[@args.first]
-        if @run_description.klass.nil?
+      # TODO:  Need to determine if the project is there, and if it's needed, then load all the
+      # actions at once.  
+      def map_command_to_action
+        @run_description.action = Action2[ @args.first ]
+        if @run_description.action.nil?
           @run_description.errors << "Unrecognized keyword <#{@args.first}>.  Quitting."
         end
       end
@@ -83,7 +75,7 @@ module EpubForge
       # 3) the current working directory (if it's an existing project)
       #
       # As a side-effect, replaces implicit directories with an explicit --project flag as the final argument
-      # because Thor seems to like explicit flags.
+      # because Thor seems to like explicit flags.  Though I'm moving away from Thor.  
       def fetch_project
         project_dir =   fetch_project_by_project_flag
         project_dir ||= fetch_project_by_second_arg
@@ -126,7 +118,14 @@ module EpubForge
       end
       
       def print_help
-        
+      end
+      
+      def load_project_machinery
+        if proj = @run_description.project
+          Action2.loader_pattern_load_from_dir( proj.settings_folder( "actions" ) )
+          Utils::HtmlTranslator.loader_pattern_load_from_dir( proj.settings_folder( "html_translators" ) )
+          Utils::Converter.loader_pattern_load_from_dir( proj.settings_folder( "converters" ) )
+        end
       end
     end
   end

data/lib/{epub → epubforge/builder}/assets/asset.rb

@@ -1,5 +1,5 @@
 module EpubForge
-  module Epub
+  module Builder
     module Assets
       class Asset
         def media_type

data/lib/{epub → epubforge/builder}/assets/font.rb

@@ -1,5 +1,5 @@
 module EpubForge
-  module Epub
+  module Builder
     module Assets
       class Font < Asset
         attr_reader :ext, :filename, :name

data/lib/epubforge/builder/assets/html.rb

@@ -0,0 +1,9 @@
+# I don't think I need separate classes for each format.
+# module EpubForge
+#   module Builder
+#     module Assets
+#       class HTML < Page
+#       end
+#     end
+#   end
+# end

data/lib/{epub → epubforge/builder}/assets/image.rb

@@ -1,5 +1,5 @@
 module EpubForge
-  module Epub
+  module Builder
     module Assets
       class Image < Asset
         attr_reader :ext, :filename, :name

data/lib/epubforge/builder/assets/markdown.rb

@@ -0,0 +1,9 @@
+# I don't think I need separate classes for each format.
+# module EpubForge
+#   module Builder
+#     module Assets
+#       class Markdown < Page
+#       end
+#     end
+#   end
+# end

data/lib/{epub → epubforge/builder}/assets/page.rb

@@ -1,14 +1,22 @@
 module EpubForge
-  module Epub
+  module Builder
     module Assets
       class Page < Asset
-        attr_reader :html, :original_file, :title, :project, :media_type, :dest_extension, :dest_filename
-        attr_reader :section_id
+        attr_reader :dest_extension, 
+                    :dest_filename,
+                    :html, 
+                    :media_type, 
+                    :original_file, 
+                    :project,
+                    :section_id,
+                    :source_format,
+                    :title
 
         def initialize file, metadata, project
           raise "NIL" if project.nil?
           
           @original_file = file.fwf_filepath
+          @source_format = @original_file.ext.to_sym
         
           @metadata = metadata
           @project  = project
@@ -25,7 +33,7 @@ module EpubForge
         end
         
         def get_html
-          @html = Utils::Htmlizer.instance.translate( @original_file )
+          @html = Utils::HtmlTranslator.translate( @original_file )
         end
         
         def get_title

data/lib/{epub → epubforge/builder}/assets/stylesheet.rb

@@ -1,5 +1,5 @@
 module EpubForge
-  module Epub
+  module Builder
     module Assets
       class Stylesheet < Asset
         attr_accessor :filename, :name, :contents

data/lib/epubforge/builder/assets/textile.rb

@@ -0,0 +1,9 @@
+# I don't think I need separate classes for each format.
+# module EpubForge
+#   module Builder
+#     module Assets
+#       class Textile < Page
+#       end
+#     end
+#   end
+# end

data/lib/epubforge/builder/assets/xhtml.rb

@@ -0,0 +1,9 @@
+# I don't think I need separate classes for each format.
+# module EpubForge
+#   module Builder
+#     module Assets
+#       class XHTML < Page
+#       end
+#     end
+#   end
+# end

data/lib/epubforge/builder/builder.rb

@@ -0,0 +1,134 @@
+# Avoiding namespace collision.
+XmlBuilder = Builder
+
+# Coaxing the project into a sort of universal format.  The parent class handles the 
+module EpubForge
+  module Builder
+    PAGE_FILE_EXTENSIONS  = %w(html markdown textile xhtml)
+    IMAGE_FILE_EXTENSIONS = %w(jpg png gif)
+    FONT_FILE_EXTENSION   = %w(ttf otf)
+
+    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",
+                    "ttf" => "application/x-font-ttf", "otf" => "application/x-font-opentype"
+                  }
+    
+    IMAGE_DIR, STYLE_DIR, TEXT_DIR, FONT_DIR = %w(Images Styles Text Fonts).map{ |dir| 
+      "/".fwf_filepath.join("OEBPS", dir) 
+    }
+        
+    class Builder
+      attr_reader :stylesheets
+      attr_reader :project
+      
+      def initialize project, opts = {}
+        target_file = opts[:target_file] || project.filename_for_book.ext("epub")  # TODO: But what about notes?
+        
+        # puts "--------------- forgin' #{ target_file } ------------------"
+
+        @project = project
+        @config  = project.config
+        @book_dir_short = opts[:book_dir] ? opts[:book_dir].split.last.to_s : "book"
+        @book_dir = @project.root_dir.join( @book_dir_short )   # TODO: .expand?
+        
+        @config.page_orderer = Utils::FileOrderer.new( opts[:page_order] || @config.pages[@book_dir_short] )
+
+        @metadata = @config.metadata || {}
+        
+        
+        initialize_page_assets
+        initialize_image_assets
+        initialize_stylesheet_assets
+        initialize_font_assets
+        install_cover
+        
+        @scratch_dir = FunWith::Files::FilePath.tmpdir.join( "ebookdir" )
+      end
+      
+      def initialize_page_assets
+        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", "html", "textile", "xhtml"
+            Assets::Page.new( section, @metadata, self )
+          #   Assets::Markdown.new( section, @metadata, self ) 
+          # when "html"
+          #   Assets::HTML.new( section, @metadata, self )
+          # when "textile"
+          #   Assets::Textile.new( section, @metadata, self )
+          # when "xhtml"
+          #   Assets::XHTML.new( section, @metadata, self )  # These files are inserted into the book unaltered
+          else
+            raise "UNKNOWN EXTENSION TYPE"
+          end
+        end
+      end
+      
+      def initialize_image_assets
+        images = @book_dir.glob( "images", ext: IMAGE_FILE_EXTENSIONS )
+        @images = images.map{ |img| Assets::Image.new(img) }
+      end
+      
+      def initialize_stylesheet_assets
+        @stylesheets = @book_dir.glob( "stylesheets", "*.css" ).map do |sheet| 
+          Assets::Stylesheet.new( sheet ) 
+        end
+      end
+      
+      def initialize_font_assets
+        @fonts = @book_dir.glob( "fonts", ext: FONT_FILE_EXTENSION ).map do |font|
+          Assets::Font.new( font )
+        end
+      end
+          
+      
+      def install_cover
+        # Existing cover is moved to the very front
+        if @cover_section = @sections.detect(&:cover?)
+          # no need to do anything
+        elsif @cover_image = @images.detect(&:cover?)
+          # actually install cover
+          contents = "<div id='cover'><img class='cover' src='#{@cover_image.link.relative_path_from(TEXT_DIR)}' alt='#{@metadata.name}, by #{@metadata.author}'/></div>"
+          cover_file = @project.book_dir.join( "cover.xhtml" )
+          cover_file.write( wrap_page( contents, "cover" ) )
+          @cover_section = Assets::Page.new( cover_file, @metadata, @project )
+          @sections.unshift( @cover_section )
+          puts "cover page generated"
+        else
+          return false
+        end
+      end
+
+   
+  
+      protected      
+      
+      # Useful for multiple builders
+      # body_id provides a section-specific hook for CSS customizing.
+      def wrap_page( content = "", body_id = "body_class" )
+        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.relative_path_from("/OEBPS/Text"), :media => "all", :rel => "stylesheet", :type => "text/css"
+            end
+          end
+    
+          
+          b.body( :id => body_id ) do
+            b << content
+          end
+        end
+  
+        b.target!.to_s
+      end
+    end
+  end
+end

data/lib/{epub/builder.rb → epubforge/builder/epub.rb}

@@ -1,91 +1,67 @@
-# Avoiding namespace collision.
-XmlBuilder = Builder
-
 module EpubForge
-  module Epub
-    PAGE_FILE_EXTENSIONS  = %w(html markdown textile xhtml)
-    IMAGE_FILE_EXTENSIONS = %w(jpg png gif)
-    FONT_FILE_EXTENSION   = %w(ttf otf)
-
-    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",
-                    "ttf" => "application/x-font-ttf", "otf" => "application/x-font-opentype"
-                  }
-    
-    IMAGE_DIR, STYLE_DIR, TEXT_DIR, FONT_DIR = %w(Images Styles Text Fonts).map{ |dir| 
-      "/".fwf_filepath.join("OEBPS", dir) 
-    }
-        
-    class Builder
-      attr_reader :stylesheets
-      attr_reader :project
+  module Builder
+    class Epub < Builder
+      def package( epub_filename )
+        epub_filename = epub_filename.fwf_filepath.expand
+        FileUtils.rm( epub_filename ) if epub_filename.exist?
+        `cd #{@scratch_dir} && zip -Xr #{epub_filename.to_s.epf_backhashed_filename} mimetype META-INF OEBPS`
+      end
       
-      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.expand
-        @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 )
-          when "xhtml"
-            Assets::XHTML.new( section, @metadata, self )  # These files are inserted into the book unaltered
-          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
-        
-        @fonts = @book_dir.glob( "fonts", ext: FONT_FILE_EXTENSION ).map do |font|
-          Assets::Font.new( font )
-        end
-    
-        install_cover
-        
-        @scratch_dir = FunWith::Files::FilePath.tmpdir.join( "ebookdir" )
+      def clean
+        # do nothing?  Remove scratch dir?
       end
       
-      def install_cover
-        # Existing cover is moved to the very front
-        if @cover_section = @sections.detect(&:cover?)
-          # no need to do anything
-        elsif @cover_image = @images.detect(&:cover?)
-          # actually install cover
-          contents = "<div id='cover'><img class='cover' src='#{@cover_image.link.relative_path_from(TEXT_DIR)}' alt='#{@metadata.name}, by #{@metadata.author}'/></div>"
-          cover_file = @project.book_dir.join( "cover.xhtml" )
-          cover_file.write( wrap_page( contents ) )
-          @cover_section = Assets::Page.new( cover_file, @metadata, @project )
-          @sections.unshift( @cover_section )
-          puts "cover page generated"
-        else
-          return false
+      # zips up contents
+      def build
+        FunWith::Files::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 do |section|
+                content = section.html
+                content = wrap_page( content, section.section_id ) unless section.source_format == :xhtml
+                
+                build.file( section.dest_filename, content )
+              end
+            end
+          
+            unless @images.fwf_blank?
+              build.dir "Images" do
+                for img in @images
+                  build.copy( img.filename )
+                end
+              end
+            end
+          
+            unless @stylesheets.fwf_blank?
+              build.dir "Styles" do
+                for sheet in @stylesheets
+                  build.file( sheet.name, sheet.contents )
+                end
+              end
+            end
+            
+            unless @fonts.fwf_blank?
+              build.dir "Fonts" do
+                for font in @fonts
+                  build.copy( font.filename )
+                end
+              end
+            end
+          end
         end
       end
-
+   
+      protected
       def toc
         b = XmlBuilder::XmlMarkup.new(:indent => 2)
         b.instruct!     # <?xml version="1.0" encoding="UTF-8"?>
@@ -222,85 +198,6 @@ module EpubForge
     
         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 do |section|
-                build.file( section.dest_filename, 
-                            section.is_a?( Assets::XHTML ) ? section.html : wrap_page( section.html )
-                          )
-              end
-            end
-          
-            unless @images.epf_blank?
-              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
-            
-            unless @fonts.epf_blank?
-              build.dir "Fonts" do
-                for font in @fonts
-                  build.copy( font.filename )
-                end
-              end
-            end
-          end
-        end
-      end
-  
-      def package epub_filename
-        Packager.new( @scratch_dir, epub_filename ).package
-      end
-      
-      def clean
-        # do nothing
-      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.relative_path_from("/OEBPS/Text"), :media => "screen", :rel => "stylesheet", :type => "text/css"
-            end
-          end
-    
-          b.body do
-            b << content
-          end
-        end
-  
-        b.target!.to_s
-      end
     end
   end
 end