epubforge 0.0.10 → 0.0.11

data/lib/epubforge/utils/html_translator_queue.rb

@@ -0,0 +1,113 @@
+
+module EpubForge
+  module Utils
+    module HtmlTranslatorQueue
+      GROUP_NAMES = [:preferred, :user, :default, :fallback]
+      
+      def self.included( base )
+        base.send( :include, FunWith::Patterns::Loader )
+        base.extend( HtmlTranslatorQueue::ClassMethods )
+        base.loader_pattern_only_register_classes( self )
+      end
+      
+      module ClassMethods
+        def loader_pattern_register_item( translator )
+          @translators ||= {}
+          @translators[:all] ||= []
+          @translators[:named] ||= {}
+        
+          for name in HtmlTranslatorQueue::GROUP_NAMES
+            @translators[name] ||= []
+          end
+
+          self.categorize( translator )
+
+          nil    # returning true will break loader
+        end
+      
+      
+      
+        def translators
+          @translators
+        end
+      
+        def categorize( translator )
+          unless GROUP_NAMES.include?( translator.group )
+            puts "No group specified for html translator #{translator}.  Group must be one of the following symbols: #{GROUP_NAMES.map(&:inspect).inspect}"
+            return false 
+          end
+        
+          @translators[:all] << translator
+          @translators[:named][translator.name] = translator if translator.name
+          @translators[translator.group] << translator
+        end
+      
+        def named( sym )
+          @translators[:named][sym]
+        end
+      
+        def each_translator( &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 location( name, path = nil )
+          @exec_location ||= {}
+          @exec_location[name] = path if path
+          @exec_location[name]
+        end
+      end
+    end
+  end
+end
+
+#     # 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
+#       def self.group_names
+#         HtmlTranslator::GROUP_NAMES
+#       end
+#       
+#       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 length
+#         @all_translators.length
+#       end
+#     end
+#   end
+# end

data/lib/epubforge/utils/htmlizer.rb

@@ -0,0 +1,61 @@
+# 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
+#         
+#         @already_set_up
+#       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
+#       #   HtmlTranslator.categorize( htmlizer )
+#       # end
+#       # 
+#       # def categorize( htmlizer )
+#       #   HtmlTranslator.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
+# 
+# 
+# 
+#     end
+#     
+#     Htmlizer.instance.setup_once
+#   end
+# end
+# 

data/lib/epubforge/utils/root_path.rb

@@ -0,0 +1,8 @@
+# should be obsoleted by FunWith::Files::RootPath
+module EpubForge
+  module Utils
+    module RootPath
+    end
+  end
+end
+

data/lib/epubforge/utils/settings.rb

@@ -0,0 +1,147 @@
+# TODO: Merge into FunWith::Configurations?
+# 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, setflag = :set )
+#         k,v = parse_kv( keqv )
+#         if setflag == :unset
+#           unset( k )
+#         elsif setflag == :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/epubforge/utils/template_evaluator.rb

@@ -0,0 +1,7 @@
+# Should be obsoleted by FunWith::Templates::TemplateEvaluator
+module EpubForge
+  module Utils
+    class TemplateEvaluator
+    end
+  end
+end

data/templates/project/book/chapter-%0000chapter%.markdown.template

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

data/templates/{default → project}/book/cover.xhtml.template

@@ -4,10 +4,10 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
-  <title></title>
+  <title><%= @book[:title] %>, by <%= @book[:author] %></title>
 </head>
 
 <body>
-  <p><img class="cover" alt="The Improbable Rise of Singularity Girl, by Bryce Anderson" src="../Images/cover.jpg" /></p>
+  <p><img class="cover" alt="<%= @book[:title] %>, by <%= @book[:author] %>" src="<%= @book[:cover].nil? ? "../Images/cover.jpg" : @book[:cover].path %>" /></p>
 </body>
 </html>

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

@@ -0,0 +1,5 @@
+<%= @book[:title] %>
+<%= "=" * (@book[:title] || "===").length %>
+
+by <%= @book[:author] %>
+

data/templates/project/notes/character.%character.name_for_file%.markdown.template

@@ -0,0 +1,15 @@
+<%= @character[:name] %>
+<%= "=" * (@character[:name] || "").length %>
+
+Summary
+-------
+
+<%= @character[:summary] %>
+
+Description
+-----------
+
+Age: <%= @character[:age] %>
+
+<%= @character[:description] %>
+

data/templates/{default → project}/settings/actions/local_action.rb.example

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class <%= @class_name %> < ThorAction
+    class <%= @class_name %> < Action
       
       <% for action in @actions %>
       desc( "<%= @slug %>:<%= action %>", "do action <%= action %>" )

data/templates/project/settings/config.rb.template

@@ -0,0 +1,70 @@
+# Used by epubforge. 
+metadata do
+  name "<%= @book[:title] || "My Book" %>"      # The title of the book
+  author "<%= @book[:author] || "Author" %>"             # Your moniker.  Your Nom de Plume.  The thing people say to get your attention.
+  license "<%= @book[:license] || "All Rights Reserved" %>"
+  publisher "<%= @book[:publisher] || 'My Publisher' %>"
+  original_publication  "<%= @book[:original_publication] || Time.now.strftime('%Y-%m-%d') %>" # The year this work was first published
+end
+
+filename "<%= (@book[:title] || "my_book").epf_underscorize %>"            # The default filename for your ebook (no extension).
+
+############### GOT GIT? #####################################
+#
+# settings to allow epubforge to interact with a git repository.  It's a way to back up your story.
+# I hope eventually to add some basic branching support (for folks who don't want to use git directly).
+# If your repo is on a thumb drive, please make sure it's plugged in.
+<% if @git %>  
+git do
+  repo_folder  "<%= @git[:repo] %>"
+  remote_host  "<%= @git[:host] %>"
+  remote_user  "<%= @git[:user] %>"
+  repo_id      "<%= @git[:repo_id] %>"
+end
+<% else %>
+# git do
+#   repo_folder  "/path/to/folder"
+#   remote_host  "my.hostname.com"
+#   remote_user  "myusername"
+#   repo_id      "not sure we're using this"
+# end
+<% end %>
+############### /GOT GIT? #####################################
+
+
+# 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.
+# 
+# Note that the items in the list represent regular expressions.  It works by
+# sorting the sections into bins, based on the first regexp matched.  Within the bins,
+# results are returned in alphabetical order.
+#
+# Single quotes are preferred, because you don't have to escape backslashes for character classes
+# like \s, \d, etc.  This needs to be made easier for people who don't have a grasp of regular
+# expressions.
+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