monad 0.0.1

data/test/test_rdiscount.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestRdiscount < Test::Unit::TestCase
+
+  context "rdiscount" do
+    setup do
+      config = {
+        'markdown' => 'rdiscount',
+        'rdiscount' => { 'extensions' => ['smart', 'generate_toc'], 'toc_token' => '{:toc}' }
+      }
+      @markdown = Converters::Markdown.new config
+    end
+
+    should "pass rdiscount extensions" do
+      assert_equal "<p>&ldquo;smart&rdquo;</p>", @markdown.convert('"smart"').strip
+    end
+
+    should "render toc" do
+      assert_equal "<h1 id=\"Header+1\">Header 1</h1>\n\n<h2 id=\"Header+2\">Header 2</h2>\n\n<p>\n <ul>\n <li><a href=\"#Header+1\">Header 1</a>\n  <ul>\n  <li><a href=\"#Header+2\">Header 2</a>  </li>\n  </ul>\n </li>\n </ul>\n\n</p>", @markdown.convert("# Header 1\n\n## Header 2\n\n{:toc}").strip
+    end
+  end
+end

data/test/test_redcarpet.rb

@@ -0,0 +1,61 @@
+require 'helper'
+
+class TestRedcarpet < Test::Unit::TestCase
+  context "redcarpet" do
+    setup do
+      @config = {
+        'redcarpet' => { 'extensions' => ['smart', 'strikethrough', 'filter_html'] },
+        'markdown' => 'redcarpet'
+      }
+      @markdown = Converters::Markdown.new @config
+    end
+
+    should "pass redcarpet options" do
+      assert_equal "<h1>Some Header</h1>", @markdown.convert('# Some Header #').strip
+    end
+
+    should "pass redcarpet SmartyPants options" do
+      assert_equal "<p>&ldquo;smart&rdquo;</p>", @markdown.convert('"smart"').strip
+    end
+
+    should "pass redcarpet extensions" do
+      assert_equal "<p><del>deleted</del></p>", @markdown.convert('~~deleted~~').strip
+    end
+
+    should "pass redcarpet render options" do
+      assert_equal "<p><strong>bad code not here</strong>: i am bad</p>", @markdown.convert('**bad code not here**: <script>i am bad</script>').strip
+    end
+
+    context "with pygments enabled" do
+      setup do
+        @markdown = Converters::Markdown.new @config.merge({ 'pygments' => true })
+      end
+
+      should "render fenced code blocks with syntax highlighting" do
+        assert_equal "<div class=\"highlight\"><pre><code class=\"ruby language-ruby\" data-lang=\"ruby\"><span class=\"nb\">puts</span> <span class=\"s2\">&quot;Hello world&quot;</span>\n</code></pre></div>", @markdown.convert(
+          <<-EOS
+```ruby
+puts "Hello world"
+```
+          EOS
+        ).strip
+      end
+    end
+
+    context "with pygments disabled" do
+      setup do
+        @markdown = Converters::Markdown.new @config.merge({ 'pygments' => false })
+      end
+
+      should "render fenced code blocks without syntax highlighting" do
+        assert_equal "<div class=\"highlight\"><pre><code class=\"ruby language-ruby\" data-lang=\"ruby\">puts &quot;Hello world&quot;\n</code></pre></div>", @markdown.convert(
+          <<-EOS
+```ruby
+puts "Hello world"
+```
+          EOS
+        ).strip
+      end
+    end
+  end
+end

data/test/test_redcloth.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestRedCloth < Test::Unit::TestCase
+
+  context "RedCloth default (no explicit config) hard_breaks enabled" do
+    setup do
+      @textile = Converters::Textile.new
+    end
+    
+    should "preserve single line breaks in HTML output" do 
+      assert_equal "<p>line1<br />\nline2</p>", @textile.convert("p. line1\nline2").strip
+    end
+  end
+
+  context "Default hard_breaks enabled w/ redcloth section, no hard_breaks value" do
+    setup do
+      config = {
+        'redcloth'      => {}
+        }
+      @textile = Converters::Textile.new config
+    end
+    
+    should "preserve single line breaks in HTML output" do 
+      assert_equal "<p>line1<br />\nline2</p>", @textile.convert("p. line1\nline2").strip
+    end
+  end
+
+  context "RedCloth with hard_breaks enabled" do
+    setup do
+      config = {
+        'redcloth'      => {
+          'hard_breaks' => true # default
+        }
+      }
+      @textile = Converters::Textile.new config
+    end
+    
+    should "preserve single line breaks in HTML output" do 
+      assert_equal "<p>line1<br />\nline2</p>", @textile.convert("p. line1\nline2").strip
+    end
+  end
+
+  context "RedCloth with hard_breaks disabled" do
+    setup do
+      config = {
+        'redcloth'      => {
+          'hard_breaks' => false
+        }
+      }
+      @textile = Converters::Textile.new config
+    end
+
+    should "not generate break tags in HTML output" do
+      assert_equal "<p>line1\nline2</p>", @textile.convert("p. line1\nline2").strip
+    end
+  end
+
+  context "RedCloth w/no_span_caps set to false" do
+    setup do
+      config = {
+        'redcloth'       => {
+          'no_span_caps' => false
+        }
+      }
+      @textile = Converters::Textile.new config
+    end
+    should "generate span tags around capitalized words" do
+      assert_equal "<p><span class=\"caps\">NSC</span></p>", @textile.convert("NSC").strip
+    end
+  end
+
+  context "RedCloth w/no_span_caps set to true" do
+    setup do
+      config = {
+        'redcloth'       => {
+          'no_span_caps' => true
+        }
+      }
+      @textile = Converters::Textile.new config
+    end
+
+    should "not generate span tags around capitalized words" do
+      assert_equal "<p>NSC</p>", @textile.convert("NSC").strip
+    end
+  end
+end

data/test/test_site.rb

@@ -0,0 +1,374 @@
+require 'helper'
+
+class TestSite < Test::Unit::TestCase
+  context "configuring sites" do
+    should "have an array for plugins by default" do
+      site = Site.new(Monad::Configuration::DEFAULTS)
+      assert_equal [File.join(Dir.pwd, '_plugins')], site.plugins
+    end
+
+    should "look for plugins under the site directory by default" do
+      site = Site.new(Monad::Configuration::DEFAULTS.merge({'source' => File.expand_path(source_dir)}))
+      assert_equal [File.join(source_dir, '_plugins')], site.plugins
+    end
+
+    should "have an array for plugins if passed as a string" do
+      site = Site.new(Monad::Configuration::DEFAULTS.merge({'plugins' => '/tmp/plugins'}))
+      assert_equal ['/tmp/plugins'], site.plugins
+    end
+
+    should "have an array for plugins if passed as an array" do
+      site = Site.new(Monad::Configuration::DEFAULTS.merge({'plugins' => ['/tmp/plugins', '/tmp/otherplugins']}))
+      assert_equal ['/tmp/plugins', '/tmp/otherplugins'], site.plugins
+    end
+
+    should "have an empty array for plugins if nothing is passed" do
+      site = Site.new(Monad::Configuration::DEFAULTS.merge({'plugins' => []}))
+      assert_equal [], site.plugins
+    end
+
+    should "have an empty array for plugins if nil is passed" do
+      site = Site.new(Monad::Configuration::DEFAULTS.merge({'plugins' => nil}))
+      assert_equal [], site.plugins
+    end
+
+    should "expose default baseurl" do
+      site = Site.new(Monad::Configuration::DEFAULTS)
+      assert_equal Monad::Configuration::DEFAULTS['baseurl'], site.baseurl
+    end
+
+    should "expose baseurl passed in from config" do
+      site = Site.new(Monad::Configuration::DEFAULTS.merge({'baseurl' => '/blog'}))
+      assert_equal '/blog', site.baseurl
+    end
+  end
+  context "creating sites" do
+    setup do
+      stub(Monad).configuration do
+        Monad::Configuration::DEFAULTS.merge({'source' => source_dir, 'destination' => dest_dir})
+      end
+      @site = Site.new(Monad.configuration)
+      @num_invalid_posts = 2
+    end
+
+    should "have an empty tag hash by default" do
+      assert_equal Hash.new, @site.tags
+    end
+
+    should "give site with parsed pages and posts to generators" do
+      @site.reset
+      @site.read
+      class MyGenerator < Generator
+        def generate(site)
+          site.pages.dup.each do |page|
+            raise "#{page} isn't a page" unless page.is_a?(Page)
+            raise "#{page} doesn't respond to :name" unless page.respond_to?(:name)
+          end
+        end
+      end
+      @site.generate
+      assert_not_equal 0, @site.pages.size
+    end
+
+    should "reset data before processing" do
+      clear_dest
+      @site.process
+      before_posts = @site.posts.length
+      before_layouts = @site.layouts.length
+      before_categories = @site.categories.length
+      before_tags = @site.tags.length
+      before_pages = @site.pages.length
+      before_static_files = @site.static_files.length
+      before_time = @site.time
+
+      @site.process
+      assert_equal before_posts, @site.posts.length
+      assert_equal before_layouts, @site.layouts.length
+      assert_equal before_categories, @site.categories.length
+      assert_equal before_tags, @site.tags.length
+      assert_equal before_pages, @site.pages.length
+      assert_equal before_static_files, @site.static_files.length
+      assert before_time <= @site.time
+    end
+
+    should "write only modified static files" do
+      clear_dest
+      StaticFile.reset_cache
+
+      @site.process
+      some_static_file = @site.static_files[0].path
+      dest = File.expand_path(@site.static_files[0].destination(@site.dest))
+      mtime1 = File.stat(dest).mtime.to_i # first run must generate dest file
+
+      # need to sleep because filesystem timestamps have best resolution in seconds
+      sleep 1
+      @site.process
+      mtime2 = File.stat(dest).mtime.to_i
+      assert_equal mtime1, mtime2
+
+      # simulate file modification by user
+      FileUtils.touch some_static_file
+
+      sleep 1
+      @site.process
+      mtime3 = File.stat(dest).mtime.to_i
+      assert_not_equal mtime2, mtime3 # must be regenerated!
+
+      sleep 1
+      @site.process
+      mtime4 = File.stat(dest).mtime.to_i
+      assert_equal mtime3, mtime4 # no modifications, so must be the same
+    end
+
+    should "write static files if not modified but missing in destination" do
+      clear_dest
+      StaticFile.reset_cache
+
+      @site.process
+      some_static_file = @site.static_files[0].path
+      dest = File.expand_path(@site.static_files[0].destination(@site.dest))
+      mtime1 = File.stat(dest).mtime.to_i # first run must generate dest file
+
+      # need to sleep because filesystem timestamps have best resolution in seconds
+      sleep 1
+      @site.process
+      mtime2 = File.stat(dest).mtime.to_i
+      assert_equal mtime1, mtime2
+
+      # simulate destination file deletion
+      File.unlink dest
+
+      sleep 1
+      @site.process
+      mtime3 = File.stat(dest).mtime.to_i
+      assert_not_equal mtime2, mtime3 # must be regenerated and differ!
+
+      sleep 1
+      @site.process
+      mtime4 = File.stat(dest).mtime.to_i
+      assert_equal mtime3, mtime4 # no modifications, so must be the same
+    end
+
+    should "setup plugins in priority order" do
+      assert_equal @site.converters.sort_by(&:class).map{|c|c.class.priority}, @site.converters.map{|c|c.class.priority}
+      assert_equal @site.generators.sort_by(&:class).map{|g|g.class.priority}, @site.generators.map{|g|g.class.priority}
+    end
+
+    should "read layouts" do
+      @site.read_layouts
+      assert_equal ["default", "simple"].sort, @site.layouts.keys.sort
+    end
+
+    should "read posts" do
+      @site.read_posts('')
+      posts = Dir[source_dir('_posts', '**', '*')]
+      posts.delete_if { |post| File.directory?(post) && !Post.valid?(post) }
+      assert_equal posts.size - @num_invalid_posts, @site.posts.size
+    end
+
+    should "deploy payload" do
+      clear_dest
+      @site.process
+
+      posts = Dir[source_dir("**", "_posts", "**", "*")]
+      posts.delete_if { |post| File.directory?(post) && !Post.valid?(post) }
+      categories = %w(2013 bar baz category foo z_category publish_test win).sort
+
+      assert_equal posts.size - @num_invalid_posts, @site.posts.size
+      assert_equal categories, @site.categories.keys.sort
+      assert_equal 4, @site.categories['foo'].size
+    end
+
+    should "filter entries" do
+      ent1 = %w[foo.markdown bar.markdown baz.markdown #baz.markdown#
+              .baz.markdow foo.markdown~]
+      ent2 = %w[.htaccess _posts _pages bla.bla]
+
+      assert_equal %w[foo.markdown bar.markdown baz.markdown], @site.filter_entries(ent1)
+      assert_equal %w[.htaccess bla.bla], @site.filter_entries(ent2)
+    end
+
+    should "filter entries with exclude" do
+      excludes = %w[README TODO]
+      files = %w[index.html site.css .htaccess]
+
+      @site.exclude = excludes + ["exclude*"]
+      assert_equal files, @site.filter_entries(excludes + files + ["excludeA"])
+    end
+    
+    should "not filter entries within include" do
+      includes = %w[_index.html .htaccess include*]
+      files = %w[index.html _index.html .htaccess includeA]
+
+      @site.include = includes
+      assert_equal files, @site.filter_entries(files)
+    end
+
+    should "filter symlink entries when safe mode enabled" do
+      stub(Monad).configuration do
+        Monad::Configuration::DEFAULTS.merge({'source' => source_dir, 'destination' => dest_dir, 'safe' => true})
+      end
+      site = Site.new(Monad.configuration)
+      stub(File).symlink?('symlink.js') {true}
+      files = %w[symlink.js]
+      assert_equal [], site.filter_entries(files)
+    end
+
+    should "not filter symlink entries when safe mode disabled" do
+      stub(File).symlink?('symlink.js') {true}
+      files = %w[symlink.js]
+      assert_equal files, @site.filter_entries(files)
+    end
+
+    should "not include symlinks in safe mode" do
+      stub(Monad).configuration do
+        Monad::Configuration::DEFAULTS.merge({'source' => source_dir, 'destination' => dest_dir, 'safe' => true})
+      end
+      site = Site.new(Monad.configuration)
+
+      site.read_directories("symlink-test")
+      assert_equal [], site.pages
+      assert_equal [], site.static_files
+    end
+
+    should "include symlinks in unsafe mode" do
+      stub(Monad).configuration do
+        Monad::Configuration::DEFAULTS.merge({'source' => source_dir, 'destination' => dest_dir, 'safe' => false})
+      end
+      site = Site.new(Monad.configuration)
+
+      site.read_directories("symlink-test")
+      assert_not_equal [], site.pages
+      assert_not_equal [], site.static_files
+    end
+
+    context 'error handling' do
+      should "raise if destination is included in source" do
+        stub(Monad).configuration do
+          Monad::Configuration::DEFAULTS.merge({'source' => source_dir, 'destination' => source_dir})
+        end
+
+        assert_raise Monad::FatalException do
+          site = Site.new(Monad.configuration)
+        end
+      end
+
+      should "raise if destination is source" do
+        stub(Monad).configuration do
+          Monad::Configuration::DEFAULTS.merge({'source' => source_dir, 'destination' => File.join(source_dir, "..")})
+        end
+
+        assert_raise Monad::FatalException do
+          site = Site.new(Monad.configuration)
+        end
+      end
+    end
+
+    context 'with orphaned files in destination' do
+      setup do
+        clear_dest
+        @site.process
+        # generate some orphaned files:
+        # single file
+        File.open(dest_dir('obsolete.html'), 'w')
+        # single file in sub directory
+        FileUtils.mkdir(dest_dir('qux'))
+        File.open(dest_dir('qux/obsolete.html'), 'w')
+        # empty directory
+        FileUtils.mkdir(dest_dir('quux'))
+        FileUtils.mkdir(dest_dir('.git'))
+        FileUtils.mkdir(dest_dir('.svn'))
+        FileUtils.mkdir(dest_dir('.hg'))
+        # single file in repository
+        File.open(dest_dir('.git/HEAD'), 'w')
+        File.open(dest_dir('.svn/HEAD'), 'w')
+        File.open(dest_dir('.hg/HEAD'), 'w')
+      end
+      
+      teardown do
+        FileUtils.rm_f(dest_dir('obsolete.html'))
+        FileUtils.rm_rf(dest_dir('qux'))
+        FileUtils.rm_f(dest_dir('quux'))
+        FileUtils.rm_rf(dest_dir('.git'))
+        FileUtils.rm_rf(dest_dir('.svn'))
+        FileUtils.rm_rf(dest_dir('.hg'))
+      end
+      
+      should 'remove orphaned files in destination' do
+        @site.process
+        assert !File.exist?(dest_dir('obsolete.html'))
+        assert !File.exist?(dest_dir('qux'))
+        assert !File.exist?(dest_dir('quux'))
+        assert File.exist?(dest_dir('.git'))
+        assert File.exist?(dest_dir('.git/HEAD'))
+      end
+
+      should 'remove orphaned files in destination - keep_files .svn' do
+        config = Monad::Configuration::DEFAULTS.merge({'source' => source_dir, 'destination' => dest_dir, 'keep_files' => ['.svn']})
+        @site = Site.new(config)
+        @site.process
+        assert !File.exist?(dest_dir('.htpasswd'))
+        assert !File.exist?(dest_dir('obsolete.html'))
+        assert !File.exist?(dest_dir('qux'))
+        assert !File.exist?(dest_dir('quux'))
+        assert !File.exist?(dest_dir('.git'))
+        assert !File.exist?(dest_dir('.git/HEAD'))
+        assert File.exist?(dest_dir('.svn'))
+        assert File.exist?(dest_dir('.svn/HEAD'))
+      end
+    end
+    
+    context 'with an invalid markdown processor in the configuration' do
+      should 'not throw an error at initialization time' do
+        bad_processor = 'not a processor name'
+        assert_nothing_raised do
+          Site.new(Monad.configuration.merge({ 'markdown' => bad_processor }))
+        end
+      end
+      
+      should 'throw FatalException at process time' do
+        bad_processor = 'not a processor name'
+        s = Site.new(Monad.configuration.merge({ 'markdown' => bad_processor }))
+        assert_raise Monad::FatalException do
+          s.process
+        end
+      end
+    end
+    
+    context 'data sources' do
+      should 'not throw exception if data sources is nil' do
+        assert_nothing_raised do
+          Site.new(Monad.configuration.merge({ 'data_sources' => nil }))
+        end
+      end
+
+      should 'not throw exception if data sources is empty' do
+        assert_nothing_raised do
+          Site.new(Monad.configuration.merge({ 'data_sources' => [] }))
+        end
+      end
+
+      should 'load one data source' do
+        site = Site.new(Monad.configuration.merge({ 'data_sources' => [{'name' => 'jsonip', 'type' => 'json', 'url' => 'http://jsonip.com/'}] }))
+        site.process
+
+        assert_not_nil site.data_sources['jsonip']['ip']
+        assert_not_nil site.data_sources['jsonip']['about']
+      end
+
+      should 'load multiple data sources' do
+        jsonip = {'name' => 'jsonip', 'type' => 'json', 'url' => 'http://jsonip.com/'}
+
+        base = File.expand_path('../fixtures', __FILE__)
+        members = {'name' => 'members', 'type' => 'yaml', 'path' => File.join(base, 'members.yaml')}
+
+        site = Site.new(Monad.configuration.merge({ 'data_sources' => [jsonip, members] }))
+        site.process
+
+        assert_not_nil site.data_sources['jsonip']['ip']
+        assert_not_nil site.data_sources['jsonip']['about']
+        assert_equal site.data_sources['members'].size, 2
+      end
+    end
+  end
+end