epubforge 0.0.10 → 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3af4d3450b3369cb3d99d89942078b6b6fffc0f5
+  data.tar.gz: 32e50a33bc8ea53caa1d64075c3a0cc4ebe4f5fd
+SHA512:
+  metadata.gz: d8cb4d480ea8e8759cd3d0b94fc7bea6ebbb9d3aaa4ca9564e3743c75ddde0d7e8d3bb462e9024c5ef156a24b6038a2185b747874babfddfd966d6f326391485
+  data.tar.gz: 0bc3df2a1b8168d504f504270601fa092c81928837308a4f3f704d93a60b91258e7a8bb5c995e722e183c2e915591e5f320fc9cefbbd4a89b08198345531ad16

data/Gemfile

@@ -9,18 +9,25 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 
-gem "xdg"
-gem "builder"
+gem "xdg", "~> 2"
+gem "builder", "~> 3"
 gem "nokogiri", "~> 1.5"
-gem "thor"
+gem "thor", "~> 0"
+gem "kramdown", ">= 1.3"
+
 # gem "configurator2"
-gem 'fun_with_files'
-gem 'fun_with_configurations'
+gem 'fun_with_gems', "~> 0.0"
+gem 'fun_with_configurations', "~> 0.0"
+gem 'fun_with_templates', "~> 0.0"
+gem 'fun_with_string_colors', "~> 0.0"
+gem 'fun_with_patterns', "~> 0.0"
 
 group :development do
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.3.0"
-  gem "jeweler", "~> 1.8.4"
-  gem "shoulda", "~> 3.3"
-  gem "debugger"
+  # gem "shoulda", "~> 3.5"
+  # gem "rdoc", "~> 3.12"
+  # gem "bundler", "~> 1.0"
+  # gem "jeweler", "~> 2.0"
+  # gem "simplecov", "~> 0", ">= 0.8"
+  # gem "debugger", "~> 1", ">= 1.6"
+  gem "fun_with_testing", "~> 0.0", ">= 0.0.2"
 end

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/bin/epubforge

@@ -6,5 +6,5 @@ exec_is_in             = File.expand_path( File.dirname(__FILE__) )
 epubforge_loader_file  = File.join( exec_is_in, "..", "lib", "epubforge" )
 
 require epubforge_loader_file
-  
+
 EpubForge::Action::Runner.new.exec( *ARGV )

data/config/actions/epub.rb

@@ -0,0 +1,50 @@
+module EpubForge
+  module Action
+    class Epub < Action2
+      define_action( "epub" ) do |action|
+        # include_standard_options
+        action.help( "Create ebooks in various formats from the .markdown files in the project's book/ and notes/ subdirectories." )
+      # keyword( "forge" )
+      # desc( "forge", "Wraps the project up in a .epub (ebook) file.")
+        action.execute do
+          epub_common( "book" )
+        end
+      end
+      
+      define_action( "epub:notes" ) do |action|
+        action.help( "Create ebooks for your story bible, instead of your main book" )
+        
+        action.execute do
+          epub_common( "notes" )
+        end
+      end
+      
+      protected
+      def epub_common( target, opts = {} )
+        # opts[:page_order] ||= project.config["pages"][target]
+        case target
+        when "book"
+          opts[:book_dir] ||= project.book_dir
+          outfile = opts.delete(:outfile) || project.filename_for_book.ext("epub")
+        when "notes"
+          opts[:book_dir] ||= project.notes_dir
+          outfile = opts.delete(:outfile) || project.filename_for_notes.ext("epub")
+        else
+          # Hope the caller knows what it's doing.
+          opts[:book_dir] ||= project.book_dir.up.join( target )
+          outfile = opts.delete(:outfile) || project.root_dir.join( "#{project.default_project_basename}.#{target}.epub" )
+        end
+        
+        opts[:verbose] = verbose?
+        builder = EpubForge::Builder::Epub.new( project, opts )
+
+        builder.build
+        builder.package( outfile )
+        builder.clean
+        say_all_is_well( "Done building epub <#{outfile}>" )
+      end
+    end
+  end
+end
+
+

data/config/actions/forge.rb

@@ -1,22 +1,43 @@
 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."
+    class Forge < Action2
+      define_action( "forge" ) do |action|
+        action.help( "Create all book formats" )
+          
+        action.execute do
+          raise "todo"
+          builder = EpubForge::Builder::Epub.new( project )
+          build( builder, project.filename_for_book.ext("epub") )
+        end
+      end
+      
+      define_action( "forge:notes" ) do |action|
+        action.help( "Create all formats of of book's notes.")
+        
+        action.execute do
+          raise "todo"
+          builder = EpubForge::Builder::Epub.new( project, book_dir: project.notes_dir, 
+                                                           page_order: project.config[:pages][:notes] )
+        
+          build( builder, project.filename_for_notes.ext("epub") )
+        end
+      end
       
-      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"] )
-
+      define_action( "forge:formats" ) do |action|
+        action.help( "List information about which ebook formats are available." )
+        
+        action.execute do
+          puts "TODO!".paint( :bg_red, :white, :bold )
+          raise "todo"
+        end
+      end
+      
+      def build( builder, builds_file )
         builder.build
-        builder.package( @project.filename_for_epub_book )
+        builder.package( builds_file )
         builder.clean
-        puts "Done building epub <#{@project.filename_for_epub_book}>"
+        puts "Done building epub <#{builds_file}>"
       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/git.rb

@@ -0,0 +1,106 @@
+module EpubForge
+  module Action
+    class Git < Action2
+      define_action( "git:save" ) do |action|
+        action.help( "commit changes to your project to your repository" )
+        action.usage( "git:save 'optional commit message'" )
+        
+        action.execute do
+          
+        end
+      end
+      
+      
+      # 
+      # 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\""
+      # 
+      #   desc( "do:save", "save to your git repository")
+      #   def do( project, *args )
+      #     @project = project
+      #     @message = args.length > 0 ? args.last : "incremental backup"
+      # 
+      #     unless project_already_gitted?
+      #       say_error "Not a git-backed project.  Aborting."
+      #       say_instruction "Run 'epubforge gitify <project>' to create a backup repository."
+      #       return false
+      #     end
+      # 
+      #     `cd #{@project.root_dir} && git commit -a -m "#{@message}" && git push`
+      #   end
+      # 
+      # 
+      
+      
+      
+      define_action( "git:init" ) do |action|
+        action.help( "create a git repository of the project folder on an external host or thumb drive" )
+        
+        action.execute do
+          @project = project
+          @conf = @project.config
+          @gitconf = @conf.git
+          
+          @cli_sequence = CliSequence.new
+          @cli_sequence.default( :verbose, true )
+          @cli_sequence.default( :local_dir, @project.root_dir )
+        
+        
+          if project_already_gitted?
+            say_error "Already seems to be a git project. delete the .git folder if this is incorrect."
+            return false
+          end
+
+          project_name_with_folder = @gitconf["repo_folder"].fwf_filepath
+        
+          if @gitconf["remote_host"]
+            remote_host = "#{@gitconf['remote_user']}@#{@gitconf['remote_host']}"
+            @cli_sequence.default( :remote, remote_host )
+            project_url = "ssh://#{remote_host}#{project_name_with_folder}"
+        
+            @cli_sequence.add_remote_command( "mkdir -p #{project_name_with_folder}", "rm -rf #{project_name_with_folder}" )
+            @cli_sequence.add_remote_command( "git --bare init #{project_name_with_folder}" )
+            identifier = project_name_with_folder.join( @gitconf["repo_id"] )
+            @cli_sequence.add_remote_command( "touch #{identifier}", "rm #{identifier}" )  # undo isn't needed here, since the directory will be wiped out.
+          else
+            project_url = "file://#{project_name_with_folder}"
+            @cli_sequence.add_local_command( "mkdir -p #{project_name_with_folder}", "rm -rf #{project_name_with_folder}" )
+            @cli_sequence.add_local_command( "git --bare init #{project_name_with_folder}" )
+            identifier = project_name_with_folder.join( @gitconf["repo_id"] )
+            @cli_sequence.add_local_command( "touch #{identifier}", "rm #{identifier}" )
+          end
+  
+          # running locally
+          @cli_sequence.add_local_command "git init", "rm -rf .git"
+          @cli_sequence.add_local_command "git remote add origin #{project_url}"
+          @cli_sequence.add_local_command "git add ."
+          @cli_sequence.add_local_command "git commit -a -m \"Initial commit\""
+          @cli_sequence.add_local_command "git config branch.master.remote origin"
+          @cli_sequence.add_local_command "git config branch.master.merge refs/heads/master"
+          @cli_sequence.add_local_command "git push origin master"       # need to be explicit about branch the first time
+
+          if @cli_sequence.execute
+            say_all_is_well( "All done.  The url for this project is #{project_url}" )
+          else
+            say_error( "Command sequence failed." )
+          end
+        end
+      end
+      
+      protected
+      def git_remote_exec( cmd )
+        say_subtly( "attempting to run remotely:  #{cmd}" )
+        `cd #{@project.root_dir} && ssh #{@gitconf["remote_user"]}@#{@gitconf["remote_host"]} "#{cmd}"`
+        say( "Success: #{$?.success?}") 
+      end
+      
+      def git_local_exec( cmd )
+        say_subtly( "attempting to run locally:  #{cmd}" )
+        `cd #{@project.root_dir} && #{cmd}`
+        say( "Success: #{$?.success?}")  
+      end
+    end
+  end
+end

data/config/actions/help.rb

@@ -1,18 +1,18 @@
 module EpubForge
   module Action
-    class Help < ThorAction
-      project_not_required
-      
-      desc( "help", "print out help for the various actions.")
-      def help( *args )
-        say_instruction "epubforge [action] [folder]"
-        say_instruction "\tActions:"
-        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
+    class Help < Action2
+      define_action( "help" ) do |action|
+        action.project_not_required
+        action.help( "Print out information for various actions." )
+
+        action.execute do |*args|
+          say_instruction "epubforge [action] [folder]"
+          say_instruction "Actions:"
+          for keyword, action in Action2.loader_pattern_registry
+            say_instruction "        #{keyword} : #{action.help}"
+            say_instruction "             usage: #{$PROGRAM_NAME} #{action.usage}" unless action.usage.fwf_blank?
+          end
+        end
       end
     end
   end

data/config/actions/html.rb

@@ -0,0 +1,33 @@
+module EpubForge
+  module Action
+    class HTML < Action2
+      define_action( "html" ) do |action|
+        action.help( "Create an HTML version of your book" )
+        action.execute do
+          book_dir = @project.root_dir.join( "book" )
+          filename = @project.filename_for_book.ext( "html" )
+          html_common( book_dir, filename )
+        end
+
+        define_action( "html:notes" ) do |action|
+          action.help( "Create an HTML version of your notebook" )
+          action.execute do
+            book_dir = @project.root_dir.join( "notes" )
+            filename = @project.filename_for_notes.ext( "html" )
+            html_common( book_dir, filename )
+          end
+        end
+        
+        protected
+        def html_common( book_dir, filename )
+          builder = EpubForge::Builder::Html.new( project, {:book_dir => book_dir} )
+          
+          builder.build
+          builder.package( filename )
+          builder.clean
+          puts "Done building #{filename}.".paint(:green)
+        end
+      end
+    end
+  end
+end

data/config/actions/mobi.rb

@@ -0,0 +1,60 @@
+module EpubForge
+  module Action
+    class Mobi < Action2
+      define_action( "mobi" ) do |action|
+        action.help( "Converts .epub to .mobi." )
+        
+        action.execute do
+          converters = Utils::Converter.converts( :epub, :mobi )
+          
+          # TODO: Uses the first converter it finds.  Suboptimal.
+          for converter in converters
+            if converter.is_executable_installed?
+              @converter = converter
+              break
+            end
+          end
+          mobi_convert_common
+        end
+      end
+      
+      define_action( "mobi:convert:calibre" ) do |action|
+        action.help( "Converts .epub to .mobi, using Calibre's ebook-convert utility" )
+        action.execute do
+          @converter = Utils::Converter[:epub_to_mobi_calibre]
+          mobi_convert_common
+        end
+      end
+      
+      define_action( "mobi:convert:kindlegen" ) do |action|
+        action.execute do
+          @converter = Utils::Converter[:epub_to_mobi_kindlegen]
+          mobi_convert_common
+        end
+      end
+      
+      protected
+      def mobi_convert_common
+        src  = @project.filename_for_book.ext( "epub" )
+        dest = @project.filename_for_book.ext( "mobi" )
+        
+        unless src.file?
+          puts "Failure: source .epub doesn't exist: #{src}".pain(:red)
+        end
+        
+        # Sigh, Kindlegen is stupid
+        if @converter.label == :epub_to_mobi_kindlegen          
+          dest = dest.basename
+        end
+        
+        conversion = @converter.convert( src, { :dest => dest, :command_line_options => "" } )
+
+        if conversion
+          puts "Success!".paint(:green)
+        else
+          puts "Failure!".paint(:red)
+        end
+      end
+    end
+  end
+end

data/config/actions/new.rb

@@ -0,0 +1,182 @@
+module EpubForge
+  module Action
+    class New < Action2
+      define_action( "new" ) do |action|
+        action.project_not_required
+        
+        action.help( "Create a brand new project." )
+        action.usage( "new <DIRECTORY_NAME>" )
+        action.default( :verbose, false )
+
+        action.execute do
+          if @project.is_a?(Project)
+            say_error "The directory given (#{@project.root_dir}) is already an EpubForge project.  Quitting."
+            false
+          elsif parse_args( *args )
+            get_template_filepath_from_options
+            configure_configuration( @opts[:answers] || {} )
+            FunWith::Templates::TemplateEvaluator.write( @template_dir, self.destination_root_filepath, @template_options )
+          else
+            false
+          end
+        end
+      end
+        # 
+        # 
+        # 
+        # 
+        # 
+        # src_dirs = src_entries.select{ |d| @template_dir.join(d).directory? }.uniq
+        # 
+        # for dir in src_dirs
+        #   puts "creating dir #{dir}"
+        #   empty_directory( self.destination_root_filepath.join( dir ) )
+        #   debugger unless self.destination_root_filepath.join( dir ).directory?
+        #   5
+        # end
+        # 
+        # debugger unless self.destination_root_filepath.directory?
+        # 
+        # for entry in src_entries - src_dirs
+        #   case entry.ext
+        #   when "template"
+        #     dst = self.destination_root_filepath.join( entry ).without_ext
+        #     puts dst.inspect
+        #     puts entry.inspect
+        #     FunWith::Files::FilePath.template( entry, dst )
+        #   when "sequence"
+        #     @chapter_count ||= @opts[:answers][:chapter_count] if @opts[:answers]
+        #     @chapter_count ||= ask_prettily("Setting up chapter files.\n  How many chapters will your book have (you can add more later)? >>> ").to_i
+        # 
+        #     1.upto( @chapter_count ) do |i|
+        #       dst = self.destination_root_filepath.join( entry ).gsub( /%i%/, sprintf( "%04i", i) ).without_ext
+        #       FunWith::Files::FilePath.template( entry, dst, {:i => i} )
+        #     end
+        #   when "form"
+        #     configure_configuration( @opts[:answers] || {} )
+        #     dst = self.destination_root_filepath.join( entry ).without_ext
+        #     FunWith::Files::FilePath.template( entry, dst, @template_options )
+        #     say_all_is_well( "Your configuration is all set up!" )
+        #     say_instruction( "run 'epubforge gitify' to initialize the backup repository." )
+        #   else
+        #     copy_file( entry, self.destination_root_filepath.join( entry ) )
+        #   end
+        # end
+      # end
+      
+      protected
+      def configure_configuration(opts = {})
+        say_instruction( "Don't think too hard about these next few questions.  You can always change your mind by editing settings/config" )
+
+        opts[:book]    ||= {}
+        opts[:book][:title]   ||= ask_prettily( "What is the name of your book?" )
+        opts[:book][:author]  ||= ask_prettily( "What is the name of the author?" )
+        opts[:license] ||= ask_from_menu( "What license do you want your book under?", [ "All Rights Reserved", 
+                                                                                        "Creative Commons Non-Commercial, No Derivatives License", 
+                                                                                        "Creative Commons Non-Commercial, Share-Alike License",
+                                                                                        "GNU Free Documentation License",
+                                                                                        "Public Domain",
+                                                                                        "Other" ] )
+        if opts[:license] == "Other"
+          opts[:license] = ask_prettily( "Type in the license you wish to use : " )
+        end
+        
+        opts[:chapter] ||= (1..(ask_prettily( "How many chapters?" ).to_i))
+        
+        @template_options = opts
+        
+        if git_installed?
+          if opts[:use_git] || opts[:use_git].nil? && yes_prettily?( "Do you want to back up your project using git?" )
+            configure_git( opts[:git] || {} )
+          end
+        else
+          warn( "The program 'git' must be installed and locatable if you want epubforge to back up your project." )
+        end
+        
+        configure_character
+      end
+      
+      
+      
+      def configure_git( opts = {} )
+        opts[:remote] = "Back up to a remote host."
+        opts[:thumb]  = "Back up to an external or thumb drive."
+        opts[:backup_type] ||= ask_from_menu( "Where would you like to back up your project to?", 
+                                                                                 [ opts[:remote], 
+                                                                                   opts[:thumb] ] )
+                                                                 
+        opts[:repo_id] ||= rand(16**32).to_s(16)
+        
+        if opts[:backup_type] == opts[:remote]
+          opts[:host] ||= ask_prettily("Enter the name of the remote host : ")
+          opts[:user] ||= ask_prettily("Enter your user name : ")
+          opts[:repo] ||= ask_prettily("Enter the name of the folder on the remote host. A folder called #{backup_folder_name} will be created there : ")
+        elsif opts[:backup_type] == opts[:thumb]
+          opts[:repo] ||= ask_prettily("Enter the full path to the backup folder. A folder called #{backup_folder_name} will be created there: ")
+        else
+          say_error("I'm confused by the requested backup style <#{opts[:backup_type]}>.  Skipping git configuration.")
+          opts = nil
+          return false
+        end
+        
+        # TODO: What if the target file system uses a different file separator?
+        opts[:repo] = opts[:repo].fwf_filepath.join( backup_folder_name ) if opts[:repo].is_a?(String)
+        @template_options[:git] = opts
+        true
+      end
+      
+      def configure_character
+        @template_options[:character] = {
+          :name          => "Mr. Example Protagonist",
+          :name_for_file => "mister_example_protagonist",
+          :description   => "Tall, red hair, angry complexion, indifferent to fashion and hygiene.",
+          :summary       => "Example once drove a man to drink, because the guy's liver once killed his dad.",
+          :age           => 23
+        }
+      end
+      
+      def backup_folder_name
+        (@template_options[:book][: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 : {}
+        project_root = args.shift
+        
+        case project_root
+        when NilClass
+          say_error "No destination directory given."
+          return false
+        when Project
+          say_error "You seem to be creating a project within a project.  Cut it out."
+          return false
+        end
+        
+        self.destination_root_filepath = project_root.fwf_filepath
+        
+        if self.destination_root_filepath.exist? && 
+            (!(self.destination_root_filepath.empty?) || !(self.destination_root_filepath.directory?))
+          say_error "This action must create a new directory or act upon an empty directory.  Quitting."
+          return false
+        end
+        
+        true
+      end
+      
+      # TODO: Shouldn't the user settings / project settings also be searchable?
+      # Wouldn't preference be given to project, then user settings?
+      def get_template_filepath_from_options
+        @template_to_use = (@opts[:template] || "project").fwf_filepath  # TODO: should turn into an option 
+        if @template_to_use.absolute?
+          @template_dir = @template_to_use
+        else
+          @template_dir = EpubForge.root.join( "templates", @template_to_use )
+        end
+        
+        
+      end
+    end
+  end
+end