epubforge 0.0.5

data/lib/utils/misc.rb

@@ -0,0 +1,20 @@
+module EpubForge
+  module Utils
+    class Misc
+      # stolen from Rails constantize method, via StackOverflow
+      # http://stackoverflow.com/questions/3314475/how-do-i-get-class-object-from-string-abc-in-ruby
+      def self.constantize( str )
+        names = str.split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        
+        constant
+      end
+    end
+  end
+end

data/lib/utils/root_path.rb

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

data/lib/utils/settings.rb

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

data/lib/utils/template_evaluator.rb

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

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

@@ -0,0 +1,4 @@
+You made it all the way through the book
+========================================
+
+When I started writing this book, I had no idea someone would make it all the way to the end.  Well done.  Now go find something else to do.

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

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

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

@@ -0,0 +1,6 @@
+Foreword
+========
+
+I dedicate the book to me, without whom none of this would be written.  
+
+And to my cat, for finally getting off the keyboard and letting me type.

data/templates/default/book/stylesheets/stylesheet.css.template

@@ -0,0 +1,2 @@
+div#epubforge_scene_description{ display: none }
+

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

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

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

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

data/templates/default/notes/stylesheets/stylesheet.css.template

@@ -0,0 +1,2 @@
+div#epubforge_scene_description{ display: none }
+

data/templates/default/payload.rb

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

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

@@ -0,0 +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"
+      
+      
+      def do( project, *args )
+        puts "Do something to your project."
+      end
+    end
+  end
+end

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

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

data/templates/default/settings/wordcount.template

@@ -0,0 +1,6 @@
+# Do not edit this file... I mean, unless you really know what you're doing. 
+# Then, please carry on.
+- <%= Time.parse( Time.now.strftime("%Y-%m-%d") ) %>:
+    Notes: 0
+    Book:  0
+

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+require 'shoulda'
+require 'stringio'
+require 'thor'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'epubforge'
+
+class Test::Unit::TestCase
+end

data/test/misc/config.rb

@@ -0,0 +1,7 @@
+FunWith::Configurations::Config.new do
+  wastrel :lance
+  obsequious do
+    french :raisin
+    italian :motorcycle
+  end
+end

data/test/sample_text/sample.markdown

@@ -0,0 +1,30 @@
+This is a header
+================
+
+This is a paragraph.
+
+* This
+* is
+* an
+* unordered
+* list
+
+hello
+
+1. This
+2. is
+3. an
+3. ordered
+3. list
+
+hello
+
+1. This
+    1. is
+        1. a sublist
+2. Next item
+    1. in
+    2. outer
+    3. list
+
+[This is a link](http://slashdot.org)

data/test/sample_text/sample.textile

@@ -0,0 +1,24 @@
+h1. This is a header
+
+This is a paragraph.
+
+p. This is also a paragraph.
+
+p. _nicely italicized_, @carefully coded@, and *boldly bolded* text.
+
+p(ex). This paragraph has a classname.
+
+<pre>
+    class A
+      def bit( _of )
+        Ruby.code( for, you )
+      end
+    end
+</pre>
+
+# a list
+## with a sublist
+## another item
+
+"A link":http://google.com
+

data/test/test_custom_helpers.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestCustomHelpers < Test::Unit::TestCase  # 
+  context "Testing collect_stdout" do
+    should "not print out" do
+      outer = ""
+      inner = ""
+      
+      outer = EpubForge.collect_stdout do
+        puts "Hello"
+          inner = EpubForge.collect_stdout do
+            puts "Well this is awkward"
+          end
+        puts "world!"
+      end
+      
+      assert_equal "Hello\nworld!\n", outer, "collect_stdout not working properly"
+      assert_equal "Well this is awkward\n", inner, "collect_stdout not working properly"
+      puts "============= STDOUT printing again =============="
+    end
+  end
+end

data/test/test_directory_builder.rb

@@ -0,0 +1,141 @@
+require 'helper'
+
+DirBuilder = EpubForge::Utils::DirectoryBuilder
+
+class TestDirectoryBuilder < Test::Unit::TestCase
+  context "tearing my hair out because shoulda seems borked" do
+    should "stop blaming shoulda for my problems" do
+      assert true
+    end
+  
+    should "realize that assert statements need to be inside should blocks" do
+      assert "Okay, okay.  I get it.  Now lay off me."
+    end
+  
+    should "figure out why the hell [].is_a?(Array) returns false" do
+      assert_kind_of Array, []
+      assert [].is_a?(Array)
+      # seems fine here.
+      # subclassing Array for use in the EpubForge module seems
+      # to be the culprit.  Guess I'm not doing that.
+    end
+  end
+  
+  context "In a temporary directory" do
+    should "create a temporary directory" do
+      DirBuilder.tmpdir do |b|
+        assert_equal DirBuilder, b.class    # 
+        assert b.current_path.exist?
+      end
+    end
+  
+    should "write data to a new file" do
+      DirBuilder.tmpdir do |b|
+        assert_equal DirBuilder, b.class    # Okay, WTF does this test fail?
+        assert b.current_path
+        assert b.current_path.exist?
+        b.file("widdershins.txt") do |f|
+          f << "Hello World"
+          f.flush
+        
+          assert b.current_file.exist?
+          assert_equal 11, b.current_file.size
+        end
+      end
+    end
+  
+    should "copy files from elsewhere into the directory" do
+      DirBuilder.tmpdir do |b|
+        assert_equal DirBuilder, b.class
+        src = EpubForge.root.join("Gemfile")
+        assert src.exist?
+      
+        b.copy( EpubForge.root.join("Gemfile") )
+          
+        gemfile = b.current_path.join("Gemfile")
+        assert gemfile.exist?
+        assert !gemfile.zero?
+        assert_equal 1, gemfile.grep( /jeweler/ ).length
+      end
+    end
+  
+    should "copy files from elsewhere, renaming the file in the destination" do
+      DirBuilder.tmpdir do |b|
+        assert_equal DirBuilder, b.class
+        assert !b.current_path.join("helpers.rb").exist?
+        b.copy( EpubForge.root.join("lib", "custom_helpers.rb"), "helpers.rb" )
+        assert b.current_path.join("helpers.rb").exist?
+      end
+    end
+    
+    should "download random crap from all over the Internet" do
+      DirBuilder.tmpdir do |b|
+        gist_url = "http://bannedsorcery.com/downloads/testfile.txt"
+        gist_text = "This is a file\n==============\n\n**silent**: But _bold_! [Link](http://slashdot.org)\n"
+        b.download( gist_url, "gist.txt" )
+        
+        b.file( "gist.txt.2" ) do
+          b.download( gist_url )
+        end
+        
+        assert b.current_file.nil?
+        assert b.current_path.join("gist.txt").exist?
+        assert b.current_path.join("gist.txt.2").exist?
+        assert_equal gist_text, b.current_path.join("gist.txt").read
+      end
+    end
+  
+    should "exercise all manner of features to create a complex directory" do
+      DirBuilder.tmpdir do |b|
+        assert_equal DirBuilder, b.class
+        root = EpubForge.root
+        gemfile = root.join("Gemfile")
+        b.copy( gemfile )
+        assert gemfile.exist?
+        assert_equal gemfile.size, b.current_path.join("Gemfile").size
+        
+        b.dir( "earth" ) do
+          b.dir( "air") do
+            b.dir( "fire" ) do
+              b.dir( "water" ) do
+                b.file( "hello.txt" )
+                b.file << "H"
+                b.file << "e"
+                b.file << "l"
+                b.file << "l"
+                b.file << "o"
+              end
+              
+              assert b.current_file.nil?
+            end
+          end
+        end
+        
+        assert "Hello", b.current_path.join("earth", "air", "fire", "water", "hello.txt").read
+        
+        b.dir( "fire", "water", "earth", "air" ) do
+          assert b.current_path.exist?
+          b.copy( EpubForge.root.join("Gemfile"), "Gemfile.example" )
+          b.copy( EpubForge.root.join("Gemfile.lock"), "Gemfile.lock.example" )
+          b.copy( EpubForge.root.join("Rakefile"), "Rakefile" )
+          
+          for file in %W(Gemfile.example Gemfile.lock.example Rakefile)
+            assert b.current_path.join(file).exist?, "#{file} should exist"
+          end
+        end
+        
+        directory = ["air", "earth", "water", "fire"]
+        b.dir( *directory ) do
+          b.file( "slipstream.txt", "file contents" )
+        end
+        
+        assert b.current_path.join(*directory).exist?
+        slip = b.current_path.join(*directory).join("slipstream.txt")
+        assert slip.exist?
+        assert_equal false, slip.empty?
+        assert_equal "file contents", b.current_path.join(*directory).join( "slipstream.txt" ).read
+        
+      end
+    end
+  end
+end

data/test/test_epf_root.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+class TestDirectoryBuilder < Test::Unit::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
+    end
+  end
+end