epubforge 0.0.9 → 0.0.10

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/config/actions/forge.rb

@@ -0,0 +1,22 @@
+module EpubForge
+  module Action
+    class Forge < ThorAction
+      include_standard_options
+      description "Create ebooks in various formats from the .markdown files in the project's book/ and notes/ subdirectories."
+      
+      desc( "forge", "Wraps the project up in a .epub (ebook) file.")
+      def forge( *args )
+        before_start
+        builder = EpubForge::Epub::Builder.new( @project, :page_order => @project.config["pages"]["book"] )
+
+        builder.build
+        builder.package( @project.filename_for_epub_book )
+        builder.clean
+        puts "Done building epub <#{@project.filename_for_epub_book}>"
+      end
+      
+      desc( "forge:epub", "Wraps the project up in a .epub (ebook) file." )
+      alias :epub :forge   # I _think_ this will allow me to also use forge:epub as an alias for forge
+    end
+  end
+end

data/config/actions/help.rb

@@ -1,20 +1,18 @@
 module EpubForge
   module Action
     class Help < ThorAction
-      description "The help menu."
-      keywords    :help, :"-h", :"--help"
-      usage       "#{$PROGRAM_NAME} -h"
       project_not_required
       
-      desc( "do:help", "print out help for the various actions.")
-      def do( project, *args )
+      desc( "help", "print out help for the various actions.")
+      def help( *args )
         say_instruction "epubforge [action] [folder]"
         say_instruction "\tActions:"
-        for action in Action::Runner.new.actions_lookup.actions
-          say_instruction "\t( #{action.keywords.join(" | ")} ) :"
-          say_instruction "\t\tDescription: #{action.description}"
-          say_instruction "\t\tUsage:       #{action.usage}\n"
-        end
+        say_instruction ThorAction.command_to_action_classes.inspect
+        # for action in ThorAction.c
+        #   say_instruction "\t( #{action.keywords.join(" | ")} ) :"
+        #   say_instruction "\t\tDescription: #{action.description}"
+        #   say_instruction "\t\tUsage:       #{action.usage}\n"
+        # end
       end
     end
   end

data/config/actions/init.rb

@@ -1,12 +1,12 @@
 module EpubForge
   module Action
     class Init < ThorAction
-      keywords  :init, :initialize, :new
+      include_standard_options
       project_not_required
       
-      desc("do:init", "create a new epubforge project")
-      def do( project, *args )
-        unless project.nil? 
+      desc("init", "create a new epubforge project")
+      def init( *args )
+        unless @project.nil? 
           say_error "Project already exists.  Quitting."
           return false
         end
@@ -111,6 +111,8 @@ module EpubForge
         (@template_options[:title] || "").epf_underscorize + ".epubforge.git"
       end
       
+      # Expects the following arguments: 1:<project directory (shouldn't exist)>, 2: options hash.
+      # Options hash includes: 
       def parse_args( *args )
         @opts = args.last.is_a?(Hash) ? args.pop : {}
         root = args.shift
@@ -128,7 +130,7 @@ module EpubForge
           return false
         end
         
-        @template_to_use = "default"
+        @template_to_use = "default"  # TODO: should turn into an option 
         true
       end
     end

data/config/actions/kindle.rb

@@ -7,15 +7,12 @@ module EpubForge
       # requires_executable "ebook-convert"
       
       # TODO:  Hard-coded.  Need a global settings file?
-      KINDLE_DEVICE_DIR = "/".fwf_filepath.join( "Volumes", "Kindle" )
-      KINDLE_PUSH_DIR   = KINDLE_DEVICE_DIR.join("documents", "fic-mine")
       
-      desc( "do:kindle", "Turn your .epub file into a .mobi file.  Check to see if your Kindle is connected, then pushes it." )
+      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
-
       end
       
       protected
@@ -37,16 +34,6 @@ module EpubForge
         end
       end
       
-      def push_to_device mobi_file
-        if KINDLE_DEVICE_DIR.directory? && KINDLE_PUSH_DIR.directory?
-          FileUtils.copy( mobi_file, KINDLE_PUSH_DIR )
-          say_all_is_well "File pushed to Kindle."
-          true
-        else
-          say_error "NOT installed on Kindle.  It may not be plugged in."
-          false
-        end   
-      end
       
       def fulfill_requirements
         unless ebook_convert_installed?
@@ -54,7 +41,7 @@ module EpubForge
           return false 
         end
         
-        BookToEpub.new.do( @project )
+        Forge.new.do( @project )
         
         unless @src_epub.exist?
           say_error( "Cannot find source .epub #{src_epub}" )

data/config/actions/local_action.rb

@@ -0,0 +1,45 @@
+module EpubForge
+  module Action
+    class LocalAction < ThorAction
+      TEMPLATE = EpubForge.root( "templates", "default", "settings", "actions", "local_action.rb.example" )
+      
+      method_option :desc, :type => :string, :default => "Describe this module"
+      method_option :actions, :type => :string, :default => "do"
+      method_option :template, :type => :string, :default => TEMPLATE
+      method_option :outfile, :type => :string
+      
+      desc( "action:local:add", "description" )
+      def add( *args )
+        before_start
+
+        command_name = @args.shift       # Will either be a CamelCase (making a class) or a downcased
+        class_name ||= "ExampleAction"
+        actions = @actions.split(",").map(&:strip)
+        slug = class_name.epf_decamelize
+        template = @template
+        outfile = (@outfile || @project.settings_folder.join( "actions", "#{slug}.rb" )).fwf_filepath
+        
+        if outfile.file?
+          puts "File already exists: #{outfile}"
+          exit(-1)
+        end
+        
+        with_locals( { :desc => @desc, :class_name => class_name, :slug => slug, :actions => actions } ) do
+          erb = ERB.new( template.read )
+          result = erb.result(binding)
+          
+          outfile.write( result )
+        end
+      end
+      
+      protected
+      def before_start
+        super()
+        @desc = @options[:desc]
+        @actions = @options[:actions]
+        @template = @options[:template]
+        @outfile = @options[:outfile]
+      end
+    end
+  end
+end

data/config/actions/mobify.rb

@@ -1,21 +1,26 @@
 module EpubForge
   module Action
-    class Mobify < ThorAction
-      description "Create a .mobi book and try to push it to your Kindle (conversion requires Calibre)"
-      keywords    :mobify
-      usage       "#{$PROGRAM_NAME} mobify <project_directory(optional)>"
-      # requires_executable "ebook-convert", "ebook-convert is included as part of the Calibre ebook management software."
+    class Forge < ThorAction
+      # 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" )
       
-      desc( "do:mobify", "Turn your .epub file into a .mobi file." )
-      def do( project, *args )
-        @project = project
+      method_option :push, :type => :string, :default => KINDLE_PUSH_DIR
+      
+      desc( "forge:mobi", "Create a .mobi book. Optionally, try to push it to your Kindle.  Conversion requires Calibre (esp. the ebook-convert command-line utility)." )
+      def mobi( *args )
+        before_start
+        @push_dir = (@options[:push] ? @options[:push].fwf_filepath.expand : nil)
+        
+        @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
         
-        @args = args
         @regenerate_epub = !!( @args.include?( "--no-cache" ) )
         
         mobify
+        push if @push_dir
       end
       
       protected
@@ -35,7 +40,18 @@ module EpubForge
           false
         end
       end
-
+      
+      def push
+        if @push_dir.directory?
+          FileUtils.copy( mobi_file, @push_dir )
+          say_all_is_well "File pushed to Kindle."
+          true
+        else
+          say_error "#{@push_dir} does not exist.  eBook NOT installed.  Your device may not be plugged in."
+          false
+        end   
+      end
+      
       
       def fulfill_requirements
         unless ebook_convert_installed?
@@ -44,7 +60,7 @@ module EpubForge
         end
         
         if !@src_epub.exist? || @regenerate_epub
-          BookToEpub.new.do( @project ) 
+          Forge.new.do( @project ) 
         end
         
         unless @src_epub.exist?

data/config/actions/notes_to_epub.rb

@@ -1,13 +1,11 @@
 module EpubForge
   module Action
-    class NotesToEpub < ThorAction
-      description "Create an epub book from the .markdown files in the project's notes/ subdirectory."
-      keywords    :notes, :forge_notes
-      usage       "#{$PROGRAM_NAME} notes <project_directory> (optional if current directory)"
+    class Forge < ThorAction
+      include_standard_options
       
-      desc( "do:notes", "Wraps your story notes up in a .epub (ebook) file." )
-      def do( project, *args )
-        @project = project
+      desc( "forge:notes", "Wraps your story notes up in a .epub (ebook) file." )
+      def notes( *args )
+        before_start
         builder = EpubForge::Epub::Builder.new( @project, book_dir: @project.target_dir.join("notes"), 
                                                           page_order: @project.config[:pages][:notes] )
         builder.build

data/config/actions/spell.rb

@@ -0,0 +1,79 @@
+module EpubForge
+  module Action
+    class SpellDefinition
+      attr_accessor :incorrect, :correct, :regex, :exact, :hits
+      def initialize( incorrect, correct, opts = nil )
+        @incorrect = incorrect
+        @correct = correct
+        @opts = opts
+        @hits = 0
+        
+        @exact = !!(@opts =~ /x/)
+        if @exact
+          @regex = /(\W|^)#{@incorrect}(\W|$)/
+        else
+          @regex =   /#{@incorrect}/i
+        end
+      end
+      
+      def hit
+        @hits += 1
+      end
+    end
+    
+    class Spell < ThorAction
+      SPELL_CORRECTION_FILE = "spellings"
+      
+      description "Highlight possible misspellings, as defined by the settings file /#{SPELL_CORRECTION_FILE}."
+      keywords    :spell
+      usage       "#{$PROGRAM_NAME} spell <project_directory>"
+      
+      desc( "do:spell", "replace common misspellings." )
+      
+      def do( project, *args )
+        @project = project
+        @spellings_file = @project.settings_folder( SPELL_CORRECTION_FILE )
+        
+        load_spellings
+        
+        @auto = args.include?("--auto")
+        
+        for file in @project.pages
+          puts "\n#{file}"
+          puts "=" * file.to_s.length
+
+          file.readlines.each_with_index do |line, i|
+            for spelling in @spellings
+              if m = line.match( spelling.regex )
+                spelling.hit
+                puts "#{i}: #{spelling.incorrect} ==> #{spelling.correct} - #{line.gsub(spelling.regex, "<<<<#{spelling.incorrect}>>>>>")}"
+              end
+            end
+          end
+        end
+        
+        
+        hit_report
+      end
+      
+      protected
+      def load_spellings
+        quit_with_error( "File does not exist: #{@spellings_file}") unless @spellings_file.file?
+        @spellings = []
+        for line in @spellings_file.readlines
+          next if line =~ /^\s*(#|$)/                    # remove comments and blank lines
+          chunks = line.split("|").map(&:strip)
+          @spellings << SpellDefinition.new( *chunks )
+        end
+        
+        puts @spellings.inspect
+      end
+      
+      def hit_report
+        for spelling in @spellings.select{|spell| spell.hit > 0}.sort_by(&:hits)
+          puts "#{spelling.incorrect} ===> #{spelling.correct} (#{spelling.hits})"
+        end
+      end
+    end
+  end
+end

data/config/actions/word_count.rb

@@ -3,15 +3,17 @@ require 'time'  # for Time.parse
 module EpubForge
   module Action
     class WordCount < ThorAction
+      include_standard_options
+      
       WORD_COUNT_FILE = "wordcount"
       
-      description "Gives approximate word counts for book chapters and notes."
+      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( "do:wc", "Countify words.")
-      def do( project, *args )
-        @project = project
+      desc( "wc", "Countify words.")
+      def wc( *args )
+        before_start
         @report  = { "Notes" => wc_one_folder( @project.notes_dir ),
                      "Book"  => wc_one_folder( @project.book_dir  ) }
 

data/lib/action/actions_lookup.rb

@@ -4,13 +4,17 @@ module EpubForge
       attr_accessor :actions, :actions_directories, :keywords
 
       def initialize
+        clear
+      end
+
+      def clear
         @keywords = {}
         @actions = []
-        @actions_directories = []
+        @actions_directories = [] 
       end
-
+      
       def add_actions( *args )
-        Utils::ActionLoader.require_me( *args )
+        Utils::ActionLoader.load_me( *args )
 
         new_actions = Utils::ActionLoader.loaded_classes - @actions
         @actions += new_actions

data/lib/action/hooks_interface.rb

@@ -0,0 +1,23 @@
+# NOT EVEN REMOTELY DONE
+module EpubForge
+  module Actions
+    class HooksInterface
+      def add_hook( hookset, block )  # Symbol: either :before or :after
+        
+      end
+      
+      def run_hooks( hookset )
+        super( hookset ) unless self == ThorAction
+        
+      end
+        
+      def self.included( base )
+        if base == ThorAction
+          base.add_hook(:before) do
+            @project = @options[:project]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action/run_description.rb

@@ -3,7 +3,8 @@ module EpubForge
     class RunDescription
       attr_accessor :args,
                     :project,
-                    :keyword,
+                    :namespace,
+                    :subcommand,
                     :klass,
                     :errors,
                     :state,
@@ -12,7 +13,8 @@ module EpubForge
       def initialize
         @args = nil
         @project = nil
-        @keyword = nil
+        @namepace = nil
+        @subcommand = nil
         @klass = nil
         @errors = []
         @state = :initialized
@@ -21,7 +23,8 @@ module EpubForge
       def run
         if self.runnable?
           handle_errors do
-            @execution_returned = self.klass.new.do( self.project, *(self.args) )
+            @args[0] = (@args[0]).split(":").last
+            @execution_returned = self.klass.start( @args )
           end
         end
 
@@ -43,6 +46,14 @@ module EpubForge
         puts "Error(s) trying to complete the requested action:"
       end
       
+      def quit_on_errors
+        if self.errors?
+          self.finish
+          self.report_errors
+          exit( -1 )
+        end
+      end
+      
       def runnable?
         ! errors?
       end
@@ -65,8 +76,8 @@ module EpubForge
       
       def to_s
         str = "RunDescription:\n"
-        [ :args, :project, :keyword, :klass, :errors, :state ].each do |data|
-          str << "#{data} : #{self.send(data)}\n"
+        [ :args, :project, :namespace, :subcommand, :klass, :errors, :state ].each do |data|
+          str << "#{data} : #{self.send(data).inspect}\n"
         end
 
         str

data/lib/action/runner.rb

@@ -4,6 +4,7 @@ module EpubForge
   module Action
     class Runner
       attr_accessor :actions_lookup
+      
       def initialize
         reset
       end
@@ -11,9 +12,18 @@ module EpubForge
       def reset
         @args = []
         @run_description = RunDescription.new
-        @actions_lookup = ActionsLookup.new
-        @actions_lookup.add_actions( EpubForge::ACTIONS_DIR )
-        @actions_lookup.add_actions( EpubForge::USER_ACTIONS_DIR ) if EpubForge::USER_ACTIONS_DIR.directory?
+      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
@@ -36,82 +46,88 @@ module EpubForge
       end
     
     
-      # The priority for the project directory
-      # 1) explicitly stated directory  --project=/home/andersbr/writ/fic/new_project
-      # 2) the current working directory (if it's an existing project)
-      # 3) the final arg
-      #
-      # At this point, 
+
       protected
       def parse_args
+        @args << "help" if @args.epf_blank?
         @run_description = RunDescription.new
-        @run_description.keyword = @args.shift || "help"
-        
-        existing_project = false
-        project_dir = get_explicit_project_option( @args )
-        
-        # see if the last argument is a project directory
-        unless project_dir || @args.length == 0
-          last_arg = @args.pop
-          unless project_dir = ( Project.is_project_dir?( last_arg ) )
-            @args.push( last_arg )
-          end
-        end
         
-        # see if current working directory is a project directory
-        unless project_dir 
-          cwd = FunWith::Files::FilePath.cwd
-          if Project.is_project_dir?( cwd )
-            project_dir = cwd
-          end
-        end
+        fetch_project
+        @run_description.quit_on_errors
         
-        # At this point, if we're going to find an existing project directory, we'll have found it by now.
-        # Time to load the actions and determine whether the keyword matches an existing action
-        if project_dir && Project.is_project_dir?( project_dir )
-          existing_project = true
-          @run_description.project = Project.new( project_dir )
-          @actions_lookup.add_actions( @run_description.project.settings_folder( "actions" ) )
-          Utils::Htmlizer.instance.add_htmlizers( @run_description.project.settings_folder( "htmlizers.rb" ) )
-        end
+        load_actions_dirs
+        load_project_machinery
         
-        map_keyword_to_action
+        map_command_to_klass
         
-        if !existing_project && @run_description.klass.project_required?
+        return false unless @run_description.klass
+
+        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."
         else
           @run_description.args = @args
         end
       end
       
-      def map_keyword_to_action
-        actions = actions_lookup.keyword_to_action( @run_description.keyword )
+      def map_command_to_klass
+        @run_description.klass = ThorAction.command_to_action_classes[@args.first]
+        if @run_description.klass.nil?
+          @run_description.errors << "Unrecognized keyword <#{@args.first}>.  Quitting."
+        end
+      end
+      
+      
+      # The priority for the project directory
+      # 1) explicitly stated directory  --project=/home/andersbr/writ/fic/new_project
+      # 2) the arg immediately after the command:subcommand:subsubcommand arg
+      # 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.
+      def fetch_project
+        project_dir =   fetch_project_by_project_flag
+        project_dir ||= fetch_project_by_second_arg
+        project_dir ||= fetch_project_by_current_dir
 
-        if actions.length == 1
-          @run_description.klass = actions.first
-        elsif actions.length == 0
-          @run_description.errors << "Unrecognized keyword <#{keyword}>.  Quitting."
-          false
-        else
-          @run_description.errors << "Ambiguous keyword <#{keyword}>.  Did you mean...?\n#{actions.map(&:usage).join('\n')}"
-          false
+        if project_dir
+          @run_description.project = Project.new( project_dir )
+          @args.push( "--project=#{project_dir}" )
         end
       end
       
-      def get_explicit_project_option( args )
-        proj_opt_regex = /^--project=/
-        
-        proj_opt = args.find do |arg|
-          arg.is_a?(String) && arg.match( proj_opt_regex )
+      def fetch_project_by_project_flag
+        project_dir = nil
+        project_flag_regex = /^--proj(ect)?=/
+        @args.each_with_index do |arg, i|
+          if arg.is_a?(String) && arg =~ project_flag_regex
+            project_dir = arg.gsub( project_flag_regex, "" ).epf_remove_surrounding_quotes.fwf_filepath.expand
+            if Project.is_project_dir?( project_dir )
+              @args.delete_at(i)
+            else
+              @run_description.errors << "Project given by flag --project= is not a valid project directory."
+            end
+          end
         end
+        
+        project_dir
+      end
       
-        if proj_opt
-          args.delete( proj_opt )
-          proj_opt.gsub( proj_opt, '' ).fwf_filepath
+      def fetch_project_by_second_arg
+        if Project.is_project_dir?( @args[1] )
+          return @args.delete_at(1)
         else
-          false
+          return nil
         end
       end
+      
+      def fetch_project_by_current_dir
+        cwd = FunWith::Files::FilePath.cwd
+        project_dir = (Project.is_project_dir?( cwd ) ? cwd : nil)
+      end
+      
+      def print_help
+        
+      end
     end
   end
 end

data/lib/action/thor_action.rb

@@ -1,11 +1,51 @@
 module EpubForge
   module Action
     module SharedActionInterface
+      def actions_lookup
+        if self == ThorAction
+          @actions_lookup ||= ActionsLookup.new
+        else
+          ThorAction.actions_lookup
+        end
+      end
+      
+      def register_action_subclass( klass )
+        if self == ThorAction
+          @subclasses ||= []
+          @subclasses = (@subclasses + [klass]).uniq
+        else
+          ThorAction.register_action_subclass( klass )
+        end
+      end
+      
+      def subclasses
+        if self == ThorAction
+          @subclasses
+        else
+          ThorAction.subclasses
+        end
+      end
+      
+      def command_to_action_classes
+        if self == ThorAction
+          @command_klass_lookup ||= {}
+        else
+          ThorAction.command_to_action_classes
+        end
+      end
+      
       def description( str = nil )
         @description = str if str
         @description
       end
       
+      # eventually replace description
+      def desc( usage, description, options = {} )
+        self.command_to_action_classes[usage] = self
+        super( usage, description, options )
+      end
+
+      # TODO: Get rid of this
       def keywords( *args )
         if args.epf_blank?
           @keywords ||= []
@@ -34,16 +74,24 @@ module EpubForge
       def project_not_required
         @project_required = false
       end
+      
+      def include_standard_options
+        method_option :verbose, :type => :boolean, :default => false, :aliases => "-v"
+        method_option :debug,   :type => :boolean, :default => false, :aliases => "--dbg"
+        method_option :help,    :type => :boolean, :default => false, :aliases => "-h"
+        method_option :project, :type => :string, :default => nil, :aliases => "--proj"
+      end
     end
     
     class ThorAction < Thor
+      def self.inherited( subclass )
+        self.register_action_subclass( subclass )
+        subclass.include_standard_options
+      end
+      
       include Thor::Actions
       extend SharedActionInterface
-      
-      method_option :verbose, :type => :boolean, :default => false, :aliases => "-v"
-      method_option :debug, :type => :boolean, :default => false, :aliases => "--dbg"
-      
-      
+            
       CLEAR     = Thor::Shell::Color::CLEAR
       RED       = Thor::Shell::Color::RED
       BLUE      = Thor::Shell::Color::BLUE
@@ -54,7 +102,7 @@ module EpubForge
       ON_BLUE   = Thor::Shell::Color::ON_BLUE
       
       
-      protected
+      protected      
       def say_when_verbose( *args )
         say( *args ) if @verbose
       end
@@ -172,6 +220,19 @@ module EpubForge
       def project_already_gitted?
         @project.target_dir.join( ".git" ).directory?
       end
+      
+      def quit_with_error( msg, errno = -1 )
+        STDERR.write( "\n#{msg}\n")
+        exit( errno )
+      end
+      
+      def before_start
+        @project = @options[:project]
+        @debug   = @options[:debug]
+        @help    = @options[:help]
+        @verbose = @options[:verbose]
+        @project = Project.new( @project ) unless @project.nil?
+      end
     end
   end
 end

data/lib/core_extensions/kernel.rb

@@ -18,5 +18,13 @@ module Kernel
       instance_variable_set( var, v )
     end
   end
-  
+
+  # Runs a block of code without warnings.
+  def silence_warnings(&block)
+    warn_level = $VERBOSE
+    $VERBOSE = nil
+    result = block.call
+    $VERBOSE = warn_level
+    result
+  end  
 end

data/lib/core_extensions/string.rb

@@ -6,6 +6,18 @@ class String
   def epf_camelize
     gsub(/(?:^|_)(.)/) { $1.upcase }
   end
+  
+  def epf_decamelize
+    self.gsub( /([a-z])([A-Z])/ ) { $1.downcase + "_" + $2.downcase }.downcase
+  end
+  
+  def epf_remove_surrounding_quotes
+    self.gsub(/(^['"]|['"]$)/)
+  end
+  
+  def epf_remove_surrounding_quotes!
+    self.replace( self.epf_remove_surrounding_quotes )
+  end
 
   # TODO: Need comprehensive list of characters to be protected.
   def epf_backhashed_filename

data/lib/custom_helpers.rb

@@ -26,29 +26,34 @@ module EpubForge
       end
     end
 
+    # To see the STDOUT, simply call EpubForge.collect_stdout( STDOUT )
     def collect_stdout( dest = StringIO.new, &block )
-      raise ArgumentError.new("No block given.") unless block_given?
+      if dest == $stdout
+        yield
+      else
+        raise ArgumentError.new("No block given.") unless block_given?
       
-      prior_stdout = $stdout
-      # @epf_prior_stdout_stack ||= []
-      # @epf_prior_stdout_stack << $stdout
+        prior_stdout = $stdout
+        # @epf_prior_stdout_stack ||= []
+        # @epf_prior_stdout_stack << $stdout
        
-      $stdout = begin
-                  if dest.is_a?( String ) || dest.is_a?( Pathname )
-                    File.open( dest, "a" )
-                  elsif dest.is_a?( IO ) || dest.is_a?( StringIO )
-                    dest
-                  else
-                    raise ArgumentError.new("collect_stdout cannot take a <#{dest.class.name}> as an argument.")
+        $stdout = begin
+                    if dest.is_a?( String ) || dest.is_a?( Pathname )
+                      File.open( dest, "a" )
+                    elsif dest.is_a?( IO ) || dest.is_a?( StringIO )
+                      dest
+                    else
+                      raise ArgumentError.new("collect_stdout cannot take a <#{dest.class.name}> as an argument.")
+                    end
                   end
-                end
     
-      $stdout.sync = true
-      yield
+        $stdout.sync = true
+        yield
     
-      $stdout = prior_stdout
+        $stdout = prior_stdout
       
-      dest.is_a?( StringIO ) ? dest.string : nil
+        dest.is_a?( StringIO ) ? dest.string : nil
+      end
     end
     
     # def collect_stdout( *args, &block )

data/lib/epub/builder.rb

@@ -19,13 +19,14 @@ module EpubForge
         
     class Builder
       attr_reader :stylesheets
+      attr_reader :project
       
       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
+        @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] )

data/lib/epubforge.rb

@@ -66,7 +66,6 @@ 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'

data/lib/project/project.rb

@@ -58,6 +58,22 @@ module EpubForge
       @book_dir.glob("chapter-????.*")
     end
     
+    
+    def pages( orderer = nil )
+      case orderer
+      when NilClass
+        orderer = Utils::FileOrderer.new( self.config.pages.book || [] )
+      when Utils::FileOrderer
+        # pass
+      when Array
+        orderer = Utils::FileOrderer.new( orderer )
+      else
+        raise "Project#pages cannot take #{order.class} as an ordering object."
+      end
+      
+      orderer.reorder( @book_dir.glob( ext: EpubForge::Epub::PAGE_FILE_EXTENSIONS ) )
+    end
+    
     def load_configuration
       self.install_fwc_config_from_file( config_file )
     end

data/lib/utils/class_loader.rb

@@ -77,6 +77,26 @@ module EpubForge
           end
         end
       end
+      
+      # just loading all the files is simpler, and probably little harm from reloading.  Plus, I want
+      # to be able to split up existing ThorClasses across multiple files.
+      def self.load_me( *loadables )
+        silence_warnings do
+          for loadable in loadables
+            loadable = loadable.fwf_filepath
+          
+            if loadable.file?
+              load( loadable )
+            elsif loadable.directory?
+              for entry in loadable.glob( :ext => "rb", :recursive => true )
+                load( entry )
+              end
+            else
+              puts "Warning: No idea what I'm trying to load (#{loadable}:#{loadable.class})"
+            end
+          end
+        end
+      end
     end
   end
 end

data/templates/default/settings/actions/local_action.rb.example

@@ -1,14 +1,14 @@
 module EpubForge
   module Action
-    class ActionFromProjectActionsDirectory < ThorAction
-      description "Use this file in the actions/ folder as a template for your custom actions."
-      keywords    :project_action
-      usage       "#{$PROGRAM_NAME} project_action"
+    class <%= @class_name %> < ThorAction
       
-      
-      def do( project, *args )
-        puts "Do something to your project."
+      <% for action in @actions %>
+      desc( "<%= @slug %>:<%= action %>", "do action <%= action %>" )
+      def <%= action %>( project, *args )
+        puts "Do action <%= action %> to your project."
       end
+      
+      <% end %>
     end
   end
-end
+end

data/test/helper.rb

@@ -18,5 +18,50 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'epubforge'
 
-class Test::Unit::TestCase
+module EpubForge
+  class TestCase < Test::Unit::TestCase
+    protected
+    def create_project( verbose = false, &block )
+      EpubForge::Utils::DirectoryBuilder.tmpdir do |d|
+        pipe_output_to = (verbose ? $stdout : StringIO.new)
+        @project_dir = d.current_path.join("project")
+        
+        @printout = EpubForge.collect_stdout( pipe_output_to ) do   # collect_stdout(STDOUT) to see what's being outputted.
+          EpubForge::Action::Runner.new.exec( "init", @project_dir, fill_in_project_options )
+        end
+
+        assert @project_dir.directory?, "Project directory doesn't exist.  Cannot proceed."
+
+        @book_title = fill_in_project_options[:answers][:title]
+        @chapter_count = fill_in_project_options[:answers][:chapter_count].to_i
+        @ebook_file = @project_dir.join( @book_title.epf_underscorize + ".epub" )
+        @notes_file = @project_dir.join( @book_title.epf_underscorize + ".notes.epub" )
+
+        yield
+      end
+    end
+
+    def fill_in_project_options( opts = {} )
+      template_options = { 
+        :answers => {
+          :chapter_count => 3,
+          :title => "The Courtesan of Fate",
+          :author => "Wilberforce Poncer",
+          :license => "You Owe Me All the Money Limited License, v. 2.1",
+          :use_git => true,
+          :git => {
+            :repo_id => "abcdef0123456789",
+            :backup_type => "Back up to a remote host.",
+            :host => "myhost.somewhere.com",
+            :user => "andersbr",
+            :repo => "/home/andersbr/git"
+          }
+        }
+      }
+    
+      template_options[:answers].merge(opts)
+    
+      template_options
+    end
+  end
 end

data/test/test_custom_helpers.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestCustomHelpers < Test::Unit::TestCase  # 
+class TestCustomHelpers < EpubForge::TestCase  # 
   context "Testing collect_stdout" do
     should "not print out" do
       outer = ""

data/test/test_directory_builder.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 DirBuilder = EpubForge::Utils::DirectoryBuilder
 
-class TestDirectoryBuilder < Test::Unit::TestCase
+class TestDirectoryBuilder < EpubForge::TestCase
   context "tearing my hair out because shoulda seems borked" do
     should "stop blaming shoulda for my problems" do
       assert true

data/test/test_epf_root.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestDirectoryBuilder < Test::Unit::TestCase
+class TestDirectoryBuilder < EpubForge::TestCase
   context "testing absolute basics" do
     should "provide an accurate root" do
       assert_equal File.expand_path( File.join( File.dirname(__FILE__), ".." ) ), EpubForge.root.to_s

data/test/test_epubforge.rb

@@ -1,16 +1,17 @@
 require 'helper'
 require 'thor'
 
-class TestEpubforge < Test::Unit::TestCase  # 
+class TestEpubforge < EpubForge::TestCase  # 
   context "Testing a few basic commands" do
-    should "print successfully" do
-      printout = EpubForge.collect_stdout do
-        EpubForge::Action::Runner.new.exec    # empty args, should append --help
-      end
-
-      assert_match /\( wc \| count \)/, printout
-      assert_match /epubforge \[action\] \[folder\]/, printout
-    end
+    # TODO: Figure out wtf to do for a help system
+    # should "print successfully" do
+    #   printout = EpubForge.collect_stdout do
+    #     EpubForge::Action::Runner.new.exec    # empty args, should append --help
+    #   end
+    # 
+    #   assert_match /\( wc \| count \)/, printout
+    #   assert_match /epubforge \[action\] \[folder\]/, printout
+    # end
     
     should "initialize a new project" do
       create_project do
@@ -51,7 +52,7 @@ class TestEpubforge < Test::Unit::TestCase  #
       
       should "create an .epub file" do
         create_project do
-          printout = EpubForge.collect_stdout do
+          printout = EpubForge.collect_stdout() do    # .collect_stdout(STDOUT) to see what's going on
             EpubForge::Action::Runner.new.exec( "forge", @project_dir )
           end
           
@@ -112,54 +113,16 @@ class TestEpubforge < Test::Unit::TestCase  #
       
       should "create an .epub of the notes directory" do
         create_project do
-          EpubForge::Action::Runner.new.exec( "forge_notes", @project_dir )
-          
+          EpubForge::Action::Runner.new.exec( "forge:notes", @project_dir )
           assert @notes_file.file?
           assert ! @notes_file.empty?
         end
       end
-    end
-        
-    protected
-    def create_project( &block )
-      EpubForge::Utils::DirectoryBuilder.tmpdir do |d|
-        @project_dir = d.current_path.join("project")
-        @printout = EpubForge.collect_stdout do
-          EpubForge::Action::Runner.new.exec( "init", @project_dir, fill_in_project_options )
-        end
-        
-        assert @project_dir.directory?, "Project directory doesn't exist.  Cannot proceed."
-        
-        @book_title = fill_in_project_options[:answers][:title]
-        @chapter_count = fill_in_project_options[:answers][:chapter_count].to_i
-        @ebook_file = @project_dir.join( @book_title.epf_underscorize + ".epub" )
-        @notes_file = @project_dir.join( @book_title.epf_underscorize + ".notes.epub" )
-        
-        yield
-      end
-    end
-    
-    def fill_in_project_options( opts = {} )
-      template_options = { 
-        :answers => {
-          :chapter_count => 3,
-          :title => "The Courtesan of Fate",
-          :author => "Wilberforce Poncer",
-          :license => "You Owe Me All the Money Limited License, v. 2.1",
-          :use_git => true,
-          :git => {
-            :repo_id => "abcdef0123456789",
-            :backup_type => "Back up to a remote host.",
-            :host => "myhost.somewhere.com",
-            :user => "andersbr",
-            :repo => "/home/andersbr/git"
-          }
-        }
-      }
       
-      template_options[:answers].merge(opts)
+      should "print friggin' something when no args" do
+        EpubForge::Action::Runner.new.exec()
+      end
       
-      template_options
     end
   end
 end

data/test/test_htmlizers.rb

@@ -1,7 +1,7 @@
 require 'helper'
 Htmlizer = EpubForge::Utils::Htmlizer
 
-class TestHtmlizers < Test::Unit::TestCase
+class TestHtmlizers < EpubForge::TestCase
   context "testing htmlizers" do
     setup do
       @samples = EpubForge.root("test", "sample_text")

data/test/test_runner.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 Runner = EpubForge::Action::Runner
 
-class TestRunner < Test::Unit::TestCase  
+class TestRunner < EpubForge::TestCase  
   context "Testing argument parsing" do
     setup do
       @runner = Runner.new

data/test/test_utils.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 include EpubForge::Utils
 
-class TestUtils < Test::Unit::TestCase
+class TestUtils < EpubForge::TestCase
   context "testing file orderer" do
     should "accurately sort files in the templates/book dir" do
       files = %W(afterword.markdown 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epubforge
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xdg
@@ -214,7 +214,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - ./bin/epubforge
-- ./config/actions/book_to_epub.rb
+- ./config/actions/forge.rb
 - ./config/actions/generate.rb
 - ./config/actions/generate_chapter.rb
 - ./config/actions/git_backup.rb
@@ -223,9 +223,11 @@ files:
 - ./config/actions/help.rb
 - ./config/actions/init.rb
 - ./config/actions/kindle.rb
+- ./config/actions/local_action.rb
 - ./config/actions/mobify.rb
 - ./config/actions/notes_to_epub.rb
 - ./config/actions/notes_to_kindle.rb
+- ./config/actions/spell.rb
 - ./config/actions/version.rb
 - ./config/actions/word_count.rb
 - ./config/actions/wrap_scene_notes_in_hidden_div.rb
@@ -234,6 +236,7 @@ files:
 - ./lib/action/cli_command.rb
 - ./lib/action/cli_sequence.rb
 - ./lib/action/file_transformer.rb
+- ./lib/action/hooks_interface.rb
 - ./lib/action/run_description.rb
 - ./lib/action/runner.rb
 - ./lib/action/thor_action.rb
@@ -317,7 +320,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2032858985098992460
+      hash: -427571737354431550
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/config/actions/book_to_epub.rb

@@ -1,20 +0,0 @@
-module EpubForge
-  module Action
-    class BookToEpub < ThorAction
-      description "Create an epub book from the .markdown files in the project's book/ subdirectory."
-      keywords    :forge, :book
-      usage       "#{$PROGRAM_NAME} forge <project_directory (optional if current directory)>"
-      
-      desc( "do:forge", "Wraps the project up in a .epub (ebook) file.")
-      def do( project, *args )
-        @project = project
-        builder = EpubForge::Epub::Builder.new( @project, :page_order => @project.config["pages"]["book"] )
-
-        builder.build
-        builder.package( @project.filename_for_epub_book )
-        builder.clean
-        puts "Done building epub <#{@project.filename_for_epub_book}>"
-      end
-    end
-  end
-end