epubforge 0.0.10 → 0.0.11

data/lib/utils/html_translator_queue.rb

@@ -1,70 +0,0 @@
-module EpubForge
-  module Utils
-    # A priority stack (like a priority queue, but FILO) with a simple job: 
-    # keep track of the translators (by name and by group), and return them
-    # to the object user in the order they should be tried.
-    class HtmlTranslatorQueue
-      GROUP_NAMES = HtmlTranslator::GROUP_NAMES
-      
-      
-      def initialize
-        @translators = {}
-        @all_translators = []
-        @translators_named = {}
-        for name in GROUP_NAMES
-          @translators[name] = []
-        end
-      end
-      
-      # def translators_handling_format( requested_format )
-      #   htmlizers = GROUP_NAMES.map{ |group|
-      #     (@translator_queue.keys - [:all, :named]).map do |format|
-      #       htmlizers = @translator_queue[format][group]
-      #       htmlizers ? htmlizers.select{|html| html.handles_format?(requested_format) } : []
-      #     end
-      #   }
-      #   
-      #   htmlizers.flatten
-      # end
-      
-      # last installed, first yielded (within a given group)
-      # 
-      # Returns them in priority order, user-defined ones first.
-      # At the moment, it is up to individual translators to accept or
-      # reject the translation job based on the file format (by extension, which is lame).
-      def each( &block )
-        ordered_translators = []
-        for group in GROUP_NAMES.map{|g| @translators[g].reverse }
-          ordered_translators += group
-        end
-        
-        if block_given?
-          for translator in ordered_translators
-            yield translator
-          end
-        else
-          ordered_translators.to_enum
-        end
-      end
-      
-      def length
-        @all_translators.length
-      end
-      
-      def categorize( htmlizer )
-        unless GROUP_NAMES.include?( htmlizer.group )
-          puts "No group specified for htmlizer #{htmlizer}.  Group must be one of the following symbols: #{GROUP_NAMES.map(&:inspect).inspect}"
-          return false 
-        end
-        
-        @all_translators << htmlizer
-        @translators_named[htmlizer.name] = htmlizer if htmlizer.name
-        @translators[htmlizer.group] << htmlizer
-      end
-      
-      def named( sym )
-        @translators_named[sym]
-      end
-    end
-  end
-end

data/lib/utils/htmlizer.rb

@@ -1,92 +0,0 @@
-module EpubForge
-  module Utils
-    
-    # Htmlizer coordinates the discovery, selection, and running of HtmlTranslators.
-    # It can be handed basically any supported filetype (markdown, textile, txt), and 
-    # hand back an HTML translation of the file.
-    class Htmlizer
-      include Singleton
-
-      def setup_once
-        return false if @already_set_up 
-        @already_set_up = true
-        @exec_location = {}
-        
-        @translator_queue = HtmlTranslatorQueue.new
-        
-        add_htmlizers( EpubForge.root( 'config', 'htmlizers.rb' ) )
-        add_htmlizers( EpubForge::USER_SETTINGS.join( 'htmlizers.rb' ) )
-        
-        @already_set_up
-      end
-            
-      public
-      def location( name, path = nil )
-        @exec_location[name] = path if path
-        @exec_location[name]
-      end
-
-      # Commenting out for the moment.  Philosophically, maybe it shouldn't provide access to individual translators.
-      # def translators_named( name )
-      #   @translator_queue[:named][name]
-      # end
-
-      
-      def self.define( &block )
-        htmlizer = HtmlTranslator.new
-        yield htmlizer
-        self.instance.categorize( htmlizer )
-      end
-      
-      def categorize( htmlizer )
-        @translator_queue.categorize( htmlizer )
-      end
-      
-      def add_htmlizers( htmlizers_file )
-        if htmlizers_file.exist?
-          begin
-            require htmlizers_file.to_s
-          rescue Exception => e
-            puts e.message
-            puts e.backtrace.map{|line| "\t#{line}" }
-            puts "Failed to load htmlizers from project file #{htmlizers_file} Soldiering onward."
-          end
-        end
-      end
-
-      
-      # available options
-      # :htmlizer => the sym for the requested htmlizer.  
-      # :opts     => a string representing options to execute cmd with
-      def translate( filename, opts = {} )
-        translator  = opts[:translator]
-        translator  = @translator_queue.named( translator ) if translator.is_a?( Symbol )
-        opts      = opts[:opts] || ""
-        
-        if translator
-          if result = translator.translate( filename, {opts: opts } )
-            return result
-          else
-            puts "Named Htmlizer #{htmlizer} did not return html. Falling back on other htmlizers"
-          end
-        end
-
-        for translator in @translator_queue
-          if result = translator.translate( filename, opts )
-            return result
-          end
-        end
-        
-        "<!-- COULD NOT FIND HTMLIZER FOR #{filename} -->"
-      end
-      
-      def self.format_from_filename( filename )
-        ext = filename.fwf_filepath.ext
-        ext.epf_blank? ? :unknown : ext.to_sym
-      end
-    end
-    
-    Htmlizer.instance.setup_once
-  end
-end
-

data/lib/utils/root_path.rb

@@ -1,20 +0,0 @@
-module EpubForge
-  module Utils
-    module RootPath
-      def root( *args )
-        if args.length > 0
-          args.unshift( @root_path )
-          FilePath.new( *args )
-        else
-          FilePath.new( @root_path )
-        end
-      end
-      
-      def set_root_path( path )
-        @root_path = FilePath.new( path )
-      end
-    end
-  end
-end
-
-EpubForge.extend EpubForge::Utils::RootPath

data/lib/utils/settings.rb

@@ -1,146 +0,0 @@
-# have to make a tweak to configurator to allow it to work with project class instances
-module Configurator
-  def self.extended(base)
-    if base.respond_to?(:class_eval)
-      base.class_eval { remove_instance_variable(:@configuration) if defined? @configuration }
-    else
-      puts "EXTENDING #{base} AS WE SPEAK"
-      base.instance_variable_set( :@got_extended, true )
-      # base.instance_variable_set( :@configuration, nil )
-    end
-  end
-end
-
-module EpubForge
-  module Utils
-    class Settings
-      def self.thing_to_configure( *args )
-        if( args.length >= 1 )
-          @thing_to_configure = args.first
-        end
-        @thing_to_configure
-      end
-      
-      # Takes a configurator object and (optionally) a settings file to write it out to.
-      def initialize( configable, file = nil )
-        @configable = configable
-        @file = file.fwf_filepath.expand if file
-        install_configuration
-      end
-      
-      def act_on_string( keqv, set = :set )
-        k,v = parse_kv( keqv )
-        if set == :unset
-          unset( k )
-        elsif set == :set
-          set( k, v )
-        end
-      end
-      
-      def set( key, val )
-        setting, last_key = descend_key( key )
-        setting[last_key] = val
-      end
-      
-      def unset( key )
-        setting, last_key = descend_key( key )
-        setting.delete( last_key )
-      end
-    
-      def write_settings_file( settings_file = nil )
-        settings_file ||= @file
-        settings_file = settings_file.fwf_filepath
-        @depth = 0
-        str = indented_line("EpubForge::Utils::Settings.thing_to_configure.config do")
-        str += write_config( @configable.config.to_hash )
-        str += indented_line("end")
-        settings_file.write( str ) 
-      end
-
-      protected
-      def install_configuration
-        self.class.thing_to_configure( @configable )
-        self.class.thing_to_configure.extend( Configurator )
-        require @file
-        self.class.thing_to_configure( nil )
-      end
-
-      def indented_line( str )
-        puts " " * @depth + str + "\n"
-        " " * @depth + str + "\n"
-      end
-
-      def write_config( h )
-        str = ""
-        @depth += 2
-        for k, v in h
-          if v.is_a?(Hash)
-            str += indented_line( "#{k} do" )
-            str += write_config( v )
-            str += indented_line( "end" )
-          else
-            str += indented_line( "#{k} #{stringify_value( v )}" )
-          end
-        end
-        @depth -= 2
-
-        str
-      end
-
-      def stringify_value( v )
-        case v
-        when Regexp
-          "/#{v.source}/"
-        when Numeric
-          "#{v}"
-        when String
-          escape_string( v )
-        when FunWith::Files::FilePath
-          escape_string( v ) + ".fwf_filepath"
-        when Array                                 # TODO: Is there a way to enter arrays?
-          "[ #{ v.map{ |item| stringify_value(item) }.join(', ') } ]"
-        when NilClass
-          "nil"
-        when TrueClass
-          "true"
-        when FalseClass
-          "false"
-        end
-      end
-
-      def escape_string( s )
-        s.inspect
-      end
-
-      # If given a hierarchical setting key like git:host:url,
-      # returns the hash attached to config[:git][:host], so the caller can say
-      # rval[:url] = "bannedsorcery.com".  Creates empty hashes as it descends,
-      # if neccessary.
-      def descend_key( k )
-        keychain = k.split(":").map{ |key| :"#{key}" }
-
-        s = @configable.config
-
-        for key in keychain[0..-2]
-          s[key] ||= {}
-          s = s[key]
-        end
-
-        [s, keychain.last]
-      end
-
-      def parse_kv( str )
-        if m = str.match( /^([a-z0-9_:]+)=(.*)$/ )
-          discard, k, v = m.to_a
-        elsif m = str.match( /^([a-z0-9_:]+)$/ )
-          discard, k = m.to_a
-          v = nil
-        else
-          k = v = nil
-        end
-
-        [k, v]
-      end
-    end
-  end
-end

data/lib/utils/template_evaluator.rb

@@ -1,20 +0,0 @@
-module EpubForge
-  module Utils
-    class TemplateEvaluator
-      attr_reader :content, :vars, :result
-      def initialize( content, vars = {} )
-        if content.is_a?(Pathname) && content.file?
-          @content = @content.read
-        else
-          @content = content.to_s
-        end
-        
-        @vars = vars
-        
-        @result = with_locals(@vars) do
-          ERB.new( @content ).result( binding )
-        end
-      end
-    end
-  end
-end

data/templates/default/book/chapter-%i%.markdown.sequence

@@ -1,4 +0,0 @@
-Chapter <%= @i %>
-========<%= "=" * @i.to_s.length %>
-
-

data/templates/default/book/title_page.markdown.template

@@ -1,4 +0,0 @@
-The Adventures of Writer-Man!
-=============================
-
-by Annotatia Von Helmermurmer

data/templates/default/notes/character.named.markdown.template

@@ -1,4 +0,0 @@
-George
-======
-
-He's just a guy, y'know?

data/templates/default/payload.rb

@@ -1,65 +0,0 @@
-dir '/'
-  dir 'book'
-    template 'title_page.markdown'
-    template 'foreword.markdown'
-    template 'afterword.markdown'
-    sequence 'scene-{04i}.markdown'
-    dir 'images'
-      file 'cover.png'
-    dir 'stylesheets'
-      template 'stylesheet.css'
-  dir 'notes'
-    sequence 'character.{name}.markdown'
-  dir 'settings'
-    template 'config'
-    file 'htmlizers.rb'
-    template 'wordcount'
-    dir 'actions'
-      file 'local_action.rb.example'
-    
-
-class Munition
-end
-
-class FileSequence < Munition
-end
-
-class DirectorySequence < Munition
-end
-
-class TemplateFile < Munition
-end
-
-
-
-class Payload
-  def initialize( src, &block )
-    @munitions = []
-    yield self if block_given?
-  end
-  
-  def dir( name, &block )
-    
-    yield if block_given?
-  end
-  
-  def root( dir = nil )
-    @root = dir.fwf_filepath if dir
-    @root
-  end
-  
-  def sequence( name, count )
-    
-  end
-  
-  def deploy( dst )
-    @munitions.each do |munition|
-      munition.deploy( dst )
-    end
-  end
-end
-
-Template::Payload.new do |t|
-  dir.template 
-  
-end

data/templates/default/settings/config.rb.form

@@ -1,55 +0,0 @@
-# Used by epubforge.
-FunWith::Configurations::Config.new do
-  metadata do
-    name "<%= config[:title] || "My Book" %>"      # The title of the book
-    author "<%= config[:author] || "Author" %>"             # Your moniker.  Your Nom de Plume.  The thing people say to get your attention.
-    license "<%= config[:license] || "All Rights Reserved" %>"
-    publisher "<%= config[:publisher] || 'My Publisher' %>"
-    original_publication  "<%= config[:original_publication] || Time.now.strftime('%Y-%m-%d') %>" # The year this work was first published
-  end
-  
-  filename "<%= config[:title].epf_underscorize %>"            # The default filename for your ebook (no extension).
-
-  
-  <% if config[:git] -%>  
-  ############### GOT GIT? #####################################
-  git do
-    repo_folder  "<%= config[:git][:repo] %>"
-    remote_host  "<%= config[:git][:host] %>"
-    remote_user  "<%= config[:git][:user] %>"
-    repo_id      "<%= config[:git][:repo_id] %>"
-  end
-  ############### /GOT GIT? #####################################
-  <% end -%>
-
-
-  # Any pages not listed here will be added
-  # to the ebook after the listed pages, in alphabetical order of 
-  # filename.  In this example, the title_page.markdown file goes first,
-  # then the foreword.markdown page, then chapters 1 and 2 (in alphanumeric order)
-  # and finally the afterword.  Any pages not matched will be put after the
-  # set of matched pages.
-
-  pages do
-    book [
-      # matches title_page.markdown, title_page.textile, or 
-      # title_page.(any other valid extension). This will be the first
-      # scene/chapter/division in the book.
-      "title_page",
-      "foreword",
-
-      # filename matches chapter, followed by anything.  If you have a page called
-      # chapter_summary that comes after, you might want to define the matcher more
-      # specifically, for example 'chapter-\d+'  (chapter followed by dash followed by any number of numbers).
-      # 
-      "chapter-.*", 
-      "afterword"
-    ]
-
-    notes [
-      # You can set the order that the notes entries appear in below.
-      "example89823786",
-      "example89723987"
-    ]
-  end
-end