epubforge 0.0.10 → 0.0.11

data/config/actions/word_count.rb

@@ -2,33 +2,36 @@ require 'time'  # for Time.parse
 
 module EpubForge
   module Action
-    class WordCount < ThorAction
-      include_standard_options
+    class WordCount < Action2
+      # include_standard_options
       
       WORD_COUNT_FILE = "wordcount"
       
-      description "Manage your word counts for book chapters and notes.  wc (standalone) is main command"
-      keywords    :wc, :count
-      usage       "#{$PROGRAM_NAME} count <project_directory>"
-      
-      desc( "wc", "Countify words.")
-      def wc( *args )
-        before_start
-        @report  = { "Notes" => wc_one_folder( @project.notes_dir ),
-                     "Book"  => wc_one_folder( @project.book_dir  ) }
+      define_action( "wc" ) do |action|
+        action.help( "Manage your word counts for book chapters and notes.  wc (standalone) is main command" )
+        
+      # keywords    :wc
+      #       usage       "#{$PROGRAM_NAME} count <project_directory>"
+      #       
+      # desc( "wc", "Countify words.")
+        action.execute do
+          debugger unless @project
+          @report  = { "Notes" => wc_one_folder( @project.notes_dir ),
+                       "Book"  => wc_one_folder( @project.book_dir  ) }
 
-        load_word_count_history
-        calculate_todays_word_count
-        append_word_count_history( @report )
-        print_report
+          load_word_count_history
+          calculate_todays_word_count
+          append_word_count_history( @report )
+          print_report
         
-        say_all_is_well "Done"
-        @report
+          say_all_is_well( "Done" )
+          @report
+        end
       end
       
       protected
       def wc_one_folder( foldername )
-        foldername.glob( ext: EpubForge::Epub::PAGE_FILE_EXTENSIONS ).inject(0) do |count, file|
+        foldername.glob( ext: EpubForge::Builder::PAGE_FILE_EXTENSIONS ).inject(0) do |count, file|
           count += wc_one_file( file )
         end
       end
@@ -116,12 +119,11 @@ module EpubForge
       end
       
       def print_report
-        say "", BLUE
-        say "Wordcount", BLUE
-        say "---------", BLUE
-        say "Notes: #{@report["Notes"]}", BLUE
-        say "Book:  #{@report["Book"]}", BLUE
-        say "Today: #{@report["Today"]}", BLUE
+        say( "\nWordcount", :blue )
+        say( "---------", :blue )
+        say( "Notes: #{@report["Notes"]}", :blue )
+        say( "Book:  #{@report["Book"]}", :blue )
+        say( "Today: #{@report["Today"]}", :blue )
       end
     end
   end

data/config/{actions → actions_to_ignore}/generate.rb

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class Generate < ThorAction
+    class Generate < Action
       keywords  :new, :generate, :add
       description "Add something to the project (a new chapter, or a new wiki entry, etc.)"
     

data/config/{actions → actions_to_ignore}/git_backup.rb

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class GitBackup < ThorAction
+    class GitBackup < Action
       description "commit your project to the git repo and back it up"
       keywords :backup, :save, :commit
       usage       "#{$PROGRAM_NAME} commit <project directory (optional if current dir)> \"optional message\""
@@ -16,7 +16,7 @@ module EpubForge
           return false
         end
         
-        `cd #{@project.target_dir} && git commit -a -m "#{@message}" && git push`
+        `cd #{@project.root_dir} && git commit -a -m "#{@message}" && git push`
       end
     end
   end

data/config/{actions → actions_to_ignore}/globals.rb

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class Globals < ThorAction
+    class Globals < Action
       description "Set up global defaults for things like author name, publisher, etc."
       keywords :global
       usage       "#{$PROGRAM_NAME} global <key>=\"<val>\"  or   global -i <asks you for defaults>"

data/config/{actions → actions_to_ignore}/kindle.rb

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class Kindle < ThorAction
+    class Kindle < Action
       description "Create a .mobi book and try to push it to your Kindle (conversion requires Calibre)"
       keywords    :kindle, :push, :b2k
       usage       "#{$PROGRAM_NAME} b2k <project_directory>"
@@ -11,8 +11,8 @@ module EpubForge
       desc( "do:kindle", "<<OBSOLETE>> Turn your .epub file into a .mobi file.  Check to see if your Kindle is connected, then pushes it." )
       def do( project, *args )
         @project = project
-        @src_epub = @project.filename_for_epub_book.fwf_filepath
-        @dst_mobi = @project.filename_for_mobi_book.fwf_filepath
+        @src_epub = @project.filename_for_book.ext("epub")
+        @dst_mobi = @project.filename_for_book.ext("mobi")
       end
       
       protected

data/config/{actions → actions_to_ignore}/local_action.rb

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class LocalAction < ThorAction
+    class LocalAction < Action
       TEMPLATE = EpubForge.root( "templates", "default", "settings", "actions", "local_action.rb.example" )
       
       method_option :desc, :type => :string, :default => "Describe this module"

data/config/{actions → actions_to_ignore}/mobify.rb

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class Forge < ThorAction
+    class Forge < Action
       # TODO: These should be user-specific settings
       KINDLE_DEVICE_DIR = "/".fwf_filepath.join( "Volumes", "Kindle" )
       KINDLE_PUSH_DIR   = KINDLE_DEVICE_DIR.join( "documents", "fic-mine" )
@@ -14,8 +14,8 @@ module EpubForge
         
         @args = args
         @push, @push_to = self.push?
-        @src_epub = @project.filename_for_epub_book.fwf_filepath
-        @dst_mobi = @project.filename_for_mobi_book.fwf_filepath
+        @src_epub = @project.filename_for_book.ext("epub")
+        @dst_mobi = @project.filename_for_book.ext("mobi")
         
         @regenerate_epub = !!( @args.include?( "--no-cache" ) )
         

data/config/actions_to_ignore/notes_to_epub.rb

@@ -0,0 +1,19 @@
+# Should be obsolete
+# module EpubForge
+#   module Action
+#     class Forge < Action
+#       include_standard_options
+#       
+#       desc( "forge:notes", "Wraps your story notes up in a .epub (ebook) file." )
+#       def notes( *args )
+#         before_start
+#         builder = EpubForge::Builder::Epub.new( @project, book_dir: @project.root_dir.join("notes"), 
+#                                                           page_order: @project.config[:pages][:notes] )
+#         builder.build
+#         builder.package( @project.filename_for_notes.ext("epub") )
+#         builder.clean
+#         puts "Done building epub <#{@project.filename_for_notes.ext("epub")}>"
+#       end
+#     end
+#   end
+# end

data/config/actions_to_ignore/notes_to_kindle.rb

@@ -0,0 +1,18 @@
+# Should be obsolete
+# module EpubForge
+#   module Action
+#     class NotesToKindle < Kindle
+#       description "Create a .mobi book from the notes and try to push it to your Kindle"
+#       keywords    :n2k
+#       usage       "#{$PROGRAM_NAME} n2k <project_directory>"
+#   
+#       def do( project, args )
+#         @project = project
+#         @src_epub = @project.filename_for_notes.ext("epub")
+#         @dst_mobi = @project.filename_for_notes.ext("mobi")
+# 
+#         mobify
+#       end
+#     end
+#   end
+# end

data/config/{actions → actions_to_ignore}/spell.rb

@@ -21,7 +21,7 @@ module EpubForge
       end
     end
     
-    class Spell < ThorAction
+    class Spell < Action
       SPELL_CORRECTION_FILE = "spellings"
       
       description "Highlight possible misspellings, as defined by the settings file /#{SPELL_CORRECTION_FILE}."

data/config/{actions → actions_to_ignore}/version.rb

@@ -1,14 +1,14 @@
 module EpubForge
   module Action
-    class Version < ThorAction
-      description "Print version (v.#{EpubForge::VERSION}, to save you the trouble)"
+    class Version < Action
+      description "Print version (v.#{EpubForge.version}, to save you the trouble)"
       keywords    :version, :"--version"
       usage       "#{$PROGRAM_NAME} -v"
       project_not_required
       
       desc( "do:version", "print out help for the various actions.")
       def do( project, *args )
-        puts "epubforge v. #{EpubForge::VERSION}, Copyright Bryce Anderson.  MIT License."
+        puts "epubforge v. #{EpubForge.version}, Copyright Bryce Anderson.  MIT License."
       end
     end
   end

data/config/{actions → actions_to_ignore}/wrap_scene_notes_in_hidden_div.rb

@@ -1,6 +1,6 @@
 module EpubForge
   module Action
-    class WrapSceneNotesInHiddenDiv < ThorAction
+    class WrapSceneNotesInHiddenDiv < Action
       description "Assumes scenes are in book/scene-XXXX.markdown, and that the scene description is above the first horizontal row (a.k.a. ***** in Markdown)."
       keywords    :wrap_scene_notes
       usage       "#{$PROGRAM_NAME} wrap_scene_notes<project_directory (optional if current directory)>\n\tfollow with 'undo' to reverse transformation."

data/config/converters/epub_to_mobi.calibre.rb

@@ -0,0 +1,8 @@
+EpubForge::Utils::Converter.new do
+  label         :epub_to_mobi_calibre
+  input_format  :epub
+  output_format :mobi
+  executable    "ebook-convert"
+  
+  help          "To use #{label}, download the latest version of Calibre at http://calibre-ebook.com/download, then make sure 'ebook-convert' is in your command line's search path."
+end

data/config/converters/epub_to_mobi.kindlegen.rb

@@ -0,0 +1,11 @@
+# My thinking is that, once the direct-from-source files are generated, further file formats can
+# be handled by "converters" that take generated file X and convert to output file Y.
+
+EpubForge::Utils::Converter.new do
+  label          :epub_to_mobi_kindlegen
+  input_format   :epub
+  output_format  :mobi
+  executable     "kindlegen"
+  command        "{{x}} {{src}} -o {{dst}}"
+  help           "Kindlegen is a command-line tool by Amazon, which can be downloaded at http://www.amazon.com/gp/feature.html?docId=1000765211"
+end

data/config/html_translators/default_kramdown.html_translator.rb

@@ -0,0 +1,9 @@
+EpubForge::Utils::HtmlTranslator.new do
+  name       :epubforge_markdown
+  format     :markdown
+  group      :default                   # the default is :user, so user-defined ones don't have to set it
+
+  custom_proc do |filepath, *args|
+    Kramdown::Document.new( filepath.read ).to_html
+  end
+end

data/config/html_translators/default_markdown.html_translator.rb

@@ -0,0 +1,10 @@
+# # Uncomment if you'd rather use the multimarkdown executable
+#
+# EpubForge::Utils::HtmlTranslator.new do
+#   name       :epubforge_multimarkdown
+#   format     :markdown
+#   group      :default                   # the default is :user, so user-defined ones don't have to set it
+#   executable "multimarkdown"
+#   cmd        "{{x}} {{o}} {{f}}"
+#   # opts       ""                         # the default
+# end

data/config/html_translators/default_markdown_pandoc.html_translator.rb

@@ -0,0 +1,10 @@
+# # Uncomment if you'd rather use the pandoc executable
+#
+# EpubForge::Utils::HtmlTranslator.new do
+#   name       :epubforge_pandoc_markdown
+#   format     :markdown
+#   group      :default
+#   executable "pandoc"
+#   cmd        "{{x}} {{o}} {{f}}"
+#   opts       "--from=markdown --to=html"
+# end

data/config/html_translators/default_textile_pandoc.html_translator.rb

@@ -0,0 +1,8 @@
+EpubForge::Utils::HtmlTranslator.new do
+  name       :epubforge_pandoc_textile
+  format     :textile
+  group      :default
+  executable "pandoc"
+  cmd        "{{x}} {{o}} {{f}}"
+  opts       "--from=textile --to=html"
+end

data/config/html_translators/default_xhtml.html_translator.rb

@@ -0,0 +1,7 @@
+EpubForge::Utils::HtmlTranslator.new do
+  name       :epubforge_xhtml
+  format     :xhtml
+  group      :default
+  executable "false"
+  cmd        "cat {{f}}"
+end

data/config/html_translators/fallback_html.html_translator.rb

@@ -0,0 +1,9 @@
+# Would be nice to detect and strip out the outer tags
+# leaving only the content.
+EpubForge::Utils::HtmlTranslator.new do
+  name       :fallback_html
+  format     :html
+  group      :fallback
+  executable "false"
+  cmd        "cat {{f}}"
+end

data/config/html_translators/fallback_markdown.html_translator.rb

@@ -0,0 +1,8 @@
+# Emergency backups
+EpubForge::Utils::HtmlTranslator.new do
+  name       :fallback_markdown
+  format     :markdown
+  group      :fallback
+  executable "false"
+  cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+end

data/config/html_translators/fallback_textile.html_translator.rb

@@ -0,0 +1,7 @@
+EpubForge::Utils::HtmlTranslator.new do
+  name       :fallback_textile
+  format     :textile
+  group      :fallback
+  executable "false"
+  cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+end

data/config/html_translators/fallback_txt.html_translator.rb

@@ -0,0 +1,8 @@
+
+EpubForge::Utils::HtmlTranslator.new do
+  name       :fallback_txt
+  format     :txt
+  group      :fallback
+  executable "false"
+  cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+end

data/config/html_translators/fallback_unknown.html_translator.rb

@@ -0,0 +1,7 @@
+EpubForge::Utils::HtmlTranslator.new do
+  name       :fallback_unknown
+  format     :unknown
+  group      :fallback
+  executable "false"
+  cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+end

data/lib/epubforge.rb

@@ -1,63 +1,41 @@
-# 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 'optparse'
-require 'nokogiri'
-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 '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 )
-EpubForge::VERSION = EpubForge.root("VERSION").read
-
-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'
-
-
+require "thor"
+require "optparse"
+require "nokogiri"
+require "xdg"
+require "debugger"
+require "erb"
+require "singleton"
+require "builder"  # XML Builder, not our builder
+require "pathname"
+require "tmpdir"
+require "rbconfig"
+require "kramdown"
+require "fun_with_gems"
+require "fun_with_templates"
+require "fun_with_configurations"
+require "fun_with_string_colors"
+require "fun_with_patterns"
+    
+FunWith::StringColors.activate
+String.colorize( true )
+FunWith::Patterns::GetAndSet.activate
+
+FunWith::Gems.make_gem_fun( "EpubForge" )
 
 module EpubForge
+  USER_SETTINGS = XDG['CONFIG_HOME'].fwf_filepath( "epubforge" )
+  DEBUG = false
+
   ACTIONS_DIR  = EpubForge.root.join( "config", "actions" )
+  USER_ACTIONS_DIR  = USER_SETTINGS.join( "actions" )
+  CONVERTERS_DIR = EpubForge.root.join( "config", "converters" )
+  USER_CONVERTERS_DIR = USER_SETTINGS.join( "converters" )
+  
+  HTML_TRANSLATORS_DIR = EpubForge.root.join( "config", "html_translators" )
+  USER_HTML_TRANSLATORS_DIR = USER_SETTINGS.join( "html_translators" )
+  
   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
@@ -65,32 +43,9 @@ 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]
-
-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 'epub/assets/xhtml'
-require_relative 'project/project'
+EpubForge.extend( EpubForge::CustomHelpers )
 
-puts "Requirements loaded" if debugging?
+EpubForge::Action::Action2.loader_pattern_load_from_dir( EpubForge::ACTIONS_DIR, EpubForge::USER_ACTIONS_DIR )
+EpubForge::Utils::Converter.loader_pattern_load_from_dir( EpubForge::CONVERTERS_DIR, EpubForge::USER_CONVERTERS_DIR )
+EpubForge::Utils::HtmlTranslator.loader_pattern_load_from_dir( EpubForge::HTML_TRANSLATORS_DIR, EpubForge::USER_HTML_TRANSLATORS_DIR )
 
-puts "Done with tests inside epubforge.rb" if debugging?