epubforge 0.0.5

data/test/test_epubforge.rb

@@ -0,0 +1,164 @@
+require 'helper'
+require 'thor'
+
+class TestEpubforge < Test::Unit::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
+    
+    should "initialize a new project" do
+      create_project do
+        assert @project_dir.join( EpubForge::Project::SETTINGS_FOLDER, EpubForge::Project::CONFIG_FILE_NAME ).file?
+        assert @project_dir.join( "settings", "actions" ).directory?
+        assert @project_dir.join( "notes" ).directory?
+        assert @project_dir.join( "book", "title_page.markdown" ).file?
+        assert @project_dir.join( "book", "images", "cover.png" ).file?
+        assert_equal 1, @project_dir.join( "book", "chapter-0001.markdown" ).grep( /^Chapter/ ).length
+      end
+    end
+    
+    context "testing a fresh project" do
+      should "successfully count ALL THE WORDS!" do
+        create_project do
+          EpubForge.collect_stdout do
+            report = EpubForge::Action::Runner.new.exec( "wc", @project_dir )
+            assert_kind_of Hash, report
+            assert_equal 87, report["Book"]
+            assert_equal 94, report["Today"]
+            assert @project_dir.join( EpubForge::Project::SETTINGS_FOLDER, EpubForge::Action::WordCount::WORD_COUNT_FILE ).exist?
+          end
+        end  
+      end
+    
+      should "fail to count words when no project is given and cwd is not a project" do
+        create_project do
+          printout = EpubForge.collect_stdout do
+            assert !EpubForge::Action::Runner.new.exec( "wc" )
+          end
+          
+          assert_match /Error\(s\) trying to complete the requested action/, printout
+          assert_match /Current directory is not an epubforge project/, printout
+        end  
+      end
+      
+      should "create an .epub file" do
+        create_project do
+          printout = EpubForge.collect_stdout do
+            EpubForge::Action::Runner.new.exec( "forge", @project_dir )
+          end
+          
+          assert @ebook_file.file?
+          assert_match /Done building epub/, printout
+          
+          Dir.mktmpdir do |unzip_dir|
+            unzip_dir = unzip_dir.fwf_filepath
+            `unzip #{@ebook_file} -d #{unzip_dir}`
+            
+            unzip_dir.join("META-INF") do |d|
+              assert d.directory?
+              container = d.join( "container.xml" )
+              assert container.file?
+              
+            end
+            
+            unzip_dir.join("OEBPS") do |d|
+              d.join("Images") do |d|
+                assert d.directory?
+                assert d.join("cover.png").file?
+              end
+              
+              d.join("Text") do |d|
+                d.join( "section0002.xhtml" ) do |section|
+                  assert section.file?
+                  section_text = section.read
+                  assert_match /DOCTYPE/, section_text
+                  assert_match /<title>#{@book_title}<\/title>/, section_text
+                  assert_match /Now go find something else to do/, section_text
+                end
+              end
+              
+              d.join("Styles") do |d|
+                assert d.directory?
+              end
+              
+              d.join( "content.opf" ) do |content|
+                content_text = content.read
+                assert_match /<dc:title>#{@book_title}<\/dc:title>/, content_text
+                assert_match /Text\/section0003/, content_text
+              end
+              
+              d.join( "toc.ncx" ) do |toc|
+                assert_equal 1, toc.grep( /DOCTYPE/ ).length
+                assert_equal 4, toc.grep( /meta name=/ ).length
+                
+                section_count = EpubForge.root( "templates", "default", "book" ).glob( :ext => ["template", "sequence"] ).length + @chapter_count - 1
+                assert_equal section_count, toc.grep( /xhtml/ ).length
+                assert_equal 1, toc.grep( /#{@book_title}/ ).length
+                
+                assert_equal section_count, toc.grep( /<content src=/ ).length
+              end
+            end
+          end
+        end
+      end
+      
+      should "create an .epub of the notes directory" do
+        create_project do
+          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)
+      
+      template_options
+    end
+  end
+end

data/test/test_htmlizers.rb

@@ -0,0 +1,24 @@
+require 'helper'
+Htmlizer = EpubForge::Utils::Htmlizer
+
+class TestHtmlizers < Test::Unit::TestCase
+  context "testing htmlizers" do
+    setup do
+      @samples = EpubForge.root("test", "sample_text")
+    end
+    
+    should "test markdown" do
+      result = Htmlizer.instance.translate( @samples.join("sample.markdown") )
+      assert_match /<h1.*This is a header</, result
+    end
+    
+    should "test textile" do
+      result = Htmlizer.instance.translate( @samples.join("sample.textile") )
+      assert_match /<h1.*This is a header</, result
+    end
+    
+    should "test everything else" do
+      skip "not written"
+    end
+  end
+end

data/test/test_runner.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+Runner = EpubForge::Action::Runner
+
+class TestRunner < Test::Unit::TestCase  
+  context "Testing argument parsing" do
+    setup do
+      @runner = Runner.new
+    end
+    
+    should "parse empty args" do
+      # @runner.send( :parse_args, ???  )
+    end
+  end
+end

data/test/test_utils.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+include EpubForge::Utils
+
+class TestUtils < Test::Unit::TestCase
+  context "testing file orderer" do
+    should "accurately sort files in the templates/book dir" do
+      files = %W(afterword.markdown 
+                 chapter-0002.markdown 
+                 chapter-0001.markdown 
+                 foreword.markdown 
+                 title_page.markdown 
+                 chapter-0003.markdown)
+                 
+      files_in_expected_order = %W( title_page.markdown 
+                                    foreword.markdown 
+                                    chapter-0001.markdown 
+                                    chapter-0002.markdown 
+                                    chapter-0003.markdown 
+                                    afterword.markdown)
+                                    
+      orderers = %w(title_page foreword chapter-.* afterword)
+      reordered_files = FileOrderer.new( orderers ).reorder( files ).map(&:to_s)
+
+      assert_equal files_in_expected_order, reordered_files
+    end
+  end
+  
+  context "testing template_handler" do
+    should "evaluate erb in a string" do
+      sample = "(<%= Time.now %>): <%= @var_is_set %>"
+      result = TemplateEvaluator.new( sample, var_is_set: "true" ).result
+      
+      assert_match /true/, result
+      time_string = /\((.*)\)/.match(result)[1]
+      assert_kind_of Time, Time.parse( time_string )
+    end
+  end
+end

metadata

@@ -0,0 +1,328 @@
+--- !ruby/object:Gem::Specification
+name: epubforge
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Bryce Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xdg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fun_with_files
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fun_with_configurations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "= epubforge =\n\nWrite your book in markdown, then do all sorts of
+  increasingly nifty things with it using this command-line utility.\n\n== Project
+  description ==\n\nepubforge is a command-line utility for creating, tracking and
+  managing longer (novella and book-length) writing projects.  Write your text in
+  markdown (http://whatismarkdown.com/), use the built in actions to convert your
+  project to various ebook formats, track wordcount over the life of the project,
+  manage a story bible, and back your project up using git.\n\nOr go further and define
+  your own formatters/converters and actions in Ruby.  Have fun!\n\n\n== Contributing
+  to epubforge ==\n \n* Check out the latest master to make sure the feature hasn't
+  been implemented or the bug hasn't been fixed yet.\n* Check out the issue tracker
+  to make sure someone already hasn't requested it and/or contributed it.\n* Fork
+  the project.\n* Start a feature/bugfix branch.\n* Commit and push until you are
+  happy with your contribution.\n* Make sure to add tests for it. This is important
+  so I don't break it in a future version unintentionally.\n* Please try not to mess
+  with the Rakefile, version, or history. If you want to have your own version, or
+  is otherwise necessary, that is fine, but please isolate to its own commit so I
+  can cherry-pick around it.\n\n== Copyright ==\n\nCopyright (c) 2013 Bryce Anderson.
+  See LICENSE.txt for\nfurther details.\n\n"
+email: keeputahweird@gmail.com
+executables:
+- epubforge
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ./bin/epubforge
+- ./config/actions/book_to_epub.rb
+- ./config/actions/generate.rb
+- ./config/actions/generate_chapter.rb
+- ./config/actions/git_backup.rb
+- ./config/actions/gitify.rb
+- ./config/actions/globals.rb
+- ./config/actions/help.rb
+- ./config/actions/init.rb
+- ./config/actions/kindle.rb
+- ./config/actions/notes_to_epub.rb
+- ./config/actions/notes_to_kindle.rb
+- ./config/actions/word_count.rb
+- ./config/actions/wrap_scene_notes_in_hidden_div.rb
+- ./config/htmlizers.rb
+- ./lib/action/actions_lookup.rb
+- ./lib/action/cli_command.rb
+- ./lib/action/cli_sequence.rb
+- ./lib/action/file_transformer.rb
+- ./lib/action/run_description.rb
+- ./lib/action/runner.rb
+- ./lib/action/thor_action.rb
+- ./lib/core_extensions/array.rb
+- ./lib/core_extensions/kernel.rb
+- ./lib/core_extensions/nil_class.rb
+- ./lib/core_extensions/object.rb
+- ./lib/core_extensions/string.rb
+- ./lib/custom_helpers.rb
+- ./lib/epub/assets/asset.rb
+- ./lib/epub/assets/html.rb
+- ./lib/epub/assets/image.rb
+- ./lib/epub/assets/markdown.rb
+- ./lib/epub/assets/page.rb
+- ./lib/epub/assets/stylesheet.rb
+- ./lib/epub/assets/textile.rb
+- ./lib/epub/builder.rb
+- ./lib/epub/packager.rb
+- ./lib/epubforge.rb
+- ./lib/errors.rb
+- ./lib/project/project.rb
+- ./lib/utils/action_loader.rb
+- ./lib/utils/class_loader.rb
+- ./lib/utils/directory_builder.rb
+- ./lib/utils/downloader.rb
+- ./lib/utils/file_orderer.rb
+- ./lib/utils/file_path.rb
+- ./lib/utils/html_translator.rb
+- ./lib/utils/html_translator_queue.rb
+- ./lib/utils/htmlizer.rb
+- ./lib/utils/misc.rb
+- ./lib/utils/root_path.rb
+- ./lib/utils/settings.rb
+- ./lib/utils/template_evaluator.rb
+- ./templates/default/book/afterword.markdown.template
+- ./templates/default/book/chapter-%i%.markdown.sequence
+- ./templates/default/book/foreword.markdown.template
+- ./templates/default/book/images/cover.png
+- ./templates/default/book/stylesheets/stylesheet.css.template
+- ./templates/default/book/title_page.markdown.template
+- ./templates/default/notes/character.named.markdown.template
+- ./templates/default/notes/stylesheets/stylesheet.css.template
+- ./templates/default/payload.rb
+- ./templates/default/settings/actions/local_action.rb.example
+- ./templates/default/settings/config.rb.form
+- ./templates/default/settings/htmlizers.rb
+- ./templates/default/settings/wordcount.template
+- ./test/helper.rb
+- ./test/misc/config.rb
+- ./test/sample_text/sample.markdown
+- ./test/sample_text/sample.textile
+- ./test/test_custom_helpers.rb
+- ./test/test_directory_builder.rb
+- ./test/test_epf_root.rb
+- ./test/test_epubforge.rb
+- ./test/test_htmlizers.rb
+- ./test/test_runner.rb
+- ./test/test_utils.rb
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/epubforge
+homepage: http://github.com/darth_schmoo/epubforge
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4298602007966861026
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Write your book in markdown, then do all sorts of increasingly nifty things
+  with it.
+test_files: []