gf-Soks 1.0.4

data/test/html/poignant.html

@@ -0,0 +1,36 @@
+<h3>False</h3>
+
+	<p style="float:left"><img src="i/blix-neg.gif" title="Shape of a cat." alt="Shape of a cat." /></p>
+
+	<p><em>The cat Trady Blix.  Frozen in emptiness.  Immaculate whiskers rigid.  Placid eyes of lake.  Tail of warm icicle.  Sponsored by a Very Powerful Pause Button.</em></p>
+
+	<p>The darkness surrounding Blix can be called <strong>negative space</strong>.  Hang on to that phrase. Let it suggest that the emptiness has a negative connotation.  In a similar way, <code>nil</code> has a slightly sour note that it whistles.</p>
+
+	<p>Generally speaking, everything in Ruby has a positive charge to it.  This spark flows through strings, numbers, regexps, all of it.  Only two keywords wear a shady cloak: <code>nil</code> and <code>false</code> draggin us down.</p>
+
+	<p>You can test that charge with an <code>if</code> keyword.  It looks very much like the <code>do</code> blocks we saw in the last chapter, in that both end with an <code>end</code>.</p>
+
+
+<pre>
+  if plastic_cup
+    print "Plastic cup is on the up 'n' up!" 
+  end
+</pre>
+	<p>If <code>plastic_cup</code> contains either <code>nil</code> or <code>false</code>, you won&#8217;t see anything print to the screen.  They&#8217;re not on the <code>if</code> guest list.  So <code>if</code> isn&#8217;t going to run any of the code it&#8217;s protecting.</p>
+
+	<p>But <code>nil</code> and <code>false</code> need not walk away in shame.  They may be of questionable character, but <code>unless</code> runs a smaller establishment that caters to the bedraggled. The <code>unless</code> keyword has a policy of only allowing those with a negative charge in. Who are: <code>nil</code> and <code>false</code>.</p>
+
+
+<pre>
+  unless plastic_cup
+    print "Plastic cup is on the down low." 
+  end
+</pre>
+	<p>You can also use <code>if</code> and <code>unless</code> at the end of a single line of code, if that&#8217;s all that is being protected.</p>
+
+
+<pre>
+  print "Yeah, plastic cup is up again!" if plastic_cup
+  print "Hardly. It's down." unless plastic_cup
+</pre>
+	<p>Now that you&#8217;ve met <code>false</code>, I&#8217;m sure you can see what&#8217;s on next.</p>

data/test/html/poignant.textile

@@ -0,0 +1,36 @@
+h3. False
+
+!<i/blix-neg.gif(Shape of a cat.)!
+
+_The cat Trady Blix.  Frozen in emptiness.  Immaculate whiskers rigid.  Placid eyes of lake.  Tail of warm icicle.  Sponsored by a Very Powerful Pause Button._
+
+The darkness surrounding Blix can be called *negative space*.  Hang on to that phrase. Let it suggest that the emptiness has a negative connotation.  In a similar way, @nil@ has a slightly sour note that it whistles.
+
+Generally speaking, everything in Ruby has a positive charge to it.  This spark flows through strings, numbers, regexps, all of it.  Only two keywords wear a shady cloak: @nil@ and @false@ draggin us down.
+
+You can test that charge with an @if@ keyword.  It looks very much like the @do@ blocks we saw in the last chapter, in that both end with an @end@.
+
+<pre>
+  if plastic_cup
+    print "Plastic cup is on the up 'n' up!"
+  end
+</pre>
+
+If @plastic_cup@ contains either @nil@ or @false@, you won't see anything print to the screen.  They're not on the @if@ guest list.  So @if@ isn't going to run any of the code it's protecting.
+
+But @nil@ and @false@ need not walk away in shame.  They may be of questionable character, but @unless@ runs a smaller establishment that caters to the bedraggled. The @unless@ keyword has a policy of only allowing those with a negative charge in. Who are: @nil@ and @false@.
+
+<pre>
+  unless plastic_cup
+    print "Plastic cup is on the down low."
+  end
+</pre>
+
+You can also use @if@ and @unless@ at the end of a single line of code, if that's all that is being protected.
+
+<pre>
+  print "Yeah, plastic cup is up again!" if plastic_cup
+  print "Hardly. It's down." unless plastic_cup
+</pre>
+
+Now that you've met @false@, I'm sure you can see what's on next.

data/test/mock-objects.rb

@@ -0,0 +1,69 @@
+$:.unshift( "contrib" )
+
+require 'yaml'
+$MESSAGES = YAML.load( IO.readlines("templates/default/views/messages.yaml").join )
+
+require 'logger'
+$LOG = Logger.new(STDOUT)
+$LOG.level = Logger::WARN
+
+begin
+	require 'rubygems'
+	require_gem 'ruby-breakpoint'
+rescue LoadError
+	$LOG.info "Breakpoint library not found.  Shouldn't matter"
+end
+
+require 'fileutils'
+require 'soks'
+
+class MockWikiStore
+	include WikiFlatFileStore
+	
+	def initialize( folder )
+		@folder = folder
+		@pages = {}
+	end
+	
+	def mutate( pagename ) 
+		p yield( @pages[pagename.downcase] ||= Page.new( pagename ) )
+	end
+end
+
+module TearDownableWiki
+	include FileUtils
+
+	def setup
+		@wiki = Wiki.new( folder )
+		@view = View.new( @wiki, 'http://testsite.com','testcontent/views' )
+	end
+
+	def teardown
+		rmtree( folder )
+	end
+
+	private
+	
+	def create_file( name, content )
+		File.open( File.join( folder, name ), 'w') { |f| f.puts content }
+	end
+	
+	def files
+		Dir.entries( folder ).delete_if { |name| name =~ /^(\.+|attachment|views)$/ }.sort
+	end
+	
+	def folder
+		@folder ||= make_folder
+	end
+	
+	def make_folder
+		mkdir( 'testcontent' )
+		mkdir('testcontent/attachment')
+		File.symlink(File.join(Dir.getwd,'templates/default/views'),'testcontent/views')
+		'testcontent'
+	end
+	
+	def wait_for_queue_to_empty
+		sleep(0.1) until @wiki.event_queue.empty?
+	end
+end

data/test/test_counter-helper.rb

@@ -0,0 +1,162 @@
+require 'test/unit'
+require 'fileutils'
+require 'mock-objects' 
+require 'generator'
+require 'helpers/counter-helpers' 
+
+class TestViewCountHelper < Test::Unit::TestCase
+	include TearDownableWiki
+
+	def test_notification
+		 results = []
+		 @wiki.watch_for(:page_viewed) { |*results| }
+		 @view.render( 'test-page','view','test-viewer')
+		 wait_for_queue_to_empty
+		 assert_equal( :page_viewed, results[0] )
+		 assert_equal( 'test-page', results[1].name )
+		 assert_equal( 'view', results[2] )
+		 assert_equal( 'test-viewer', results[3] )	
+	end
+	
+	def test_total_count
+		count = ViewCountHelper.new(@wiki).counts
+		@view.render( 'test-page','view','test-viewer')
+		@view.render( 'test-page','view','test-viewer')
+		@view.render( 'test-page','view','test-viewer')
+		wait_for_queue_to_empty
+		assert_equal( 3, count.total )
+	end
+		
+	def	test_page_count
+		count = ViewCountHelper.new(@wiki, ['view'], 'Popular Pages', :test_event, 2 ).counts
+		@wiki.revise( 'count1','1','t1')
+		@wiki.revise( 'count2','2','t2')
+		@wiki.revise( 'count3','3','t3')
+		3.times { @view.render( 'count1' ) }
+		3.times { @view.render( 'count1', 'edit' ) }
+		2.times { @view.render( 'count2' ) }
+		1.times { @view.render( 'count3' ) }
+		wait_for_queue_to_empty
+		p1,p2,p3 = @wiki.page('count1'), @wiki.page('count2'), @wiki.page('count3')
+		assert_equal( 3, count[p1.name] )
+		assert_equal( 2, count[p2.name] )
+		assert_equal( 1, count[p3.name] )
+		assert_equal( 6, count.total )
+	end
+	
+	def test_page_render
+		start_time = Time.now
+		test_page_count
+		@wiki.notify( :test_event )
+		wait_for_queue_to_empty
+		content = @wiki.page('Popular Pages').content.split "\n"
+		[	[ 0, "h1. Popular Pages" ],
+			[ 4, "| count1 | 3 |" ],
+			[ 5, "| count2 | 2 |" ],
+			[ 6, "| 1 others | 1 |" ],
+			[ 7, "| *Total* | *6* |" ] ].each do |i,line|
+				assert_equal line, content[i]
+		end
+	end
+	
+end
+
+class TestViewerCountHelper < Test::Unit::TestCase
+	include TearDownableWiki
+
+	def test_notification
+		 results = []
+		 @wiki.watch_for(:page_viewed) { |*results| }
+		 @view.render( 'test-page','view','test-viewer')
+		 wait_for_queue_to_empty
+		 assert_equal( :page_viewed, results[0] )
+		 assert_equal( 'test-page', results[1].name )
+		 assert_equal( 'view', results[2] )
+		 assert_equal( 'test-viewer', results[3] )	
+	end
+	
+	def test_total_count
+		count = ViewerCountHelper.new(@wiki).counts
+		@view.render( 'test-page','view','test-viewer')
+		@view.render( 'test-page','view','test-viewer')
+		@view.render( 'test-page','view','test-viewer')
+		wait_for_queue_to_empty
+		assert_equal( 3, count.total )
+	end
+		
+	def	test_viewer_count
+		count = ViewerCountHelper.new(@wiki, ['view'], 'Popular Pages', :test_event, 2 ).counts
+		@wiki.revise( 'count1','1','t1')
+		@wiki.revise( 'count2','2','t2')
+		@wiki.revise( 'count3','3','t3')
+		3.times { @view.render( 'count1', 'view', "Author1" ) }
+		3.times { @view.render( 'count1', 'edit', "Author1" ) }
+		2.times { @view.render( 'count2', 'view', "Author2" ) }
+		1.times { @view.render( 'count3', 'view', "Author3" ) }
+		wait_for_queue_to_empty
+		assert_equal( 3, count['Author1'] )
+		assert_equal( 2, count['Author2'] )
+		assert_equal( 1, count['Author3'] )
+		assert_equal( 6, count.total )
+	end
+	
+	def test_page_render
+		start_time = Time.now
+		test_viewer_count
+		@wiki.notify( :test_event )
+		wait_for_queue_to_empty
+		content = @wiki.page('Popular Pages').content.split "\n"
+		[	[ 0, "h1. Popular Pages" ],
+			[ 4, "| Author1 | 3 |" ],
+			[ 5, "| Author2 | 2 |" ],
+			[ 6, "| 1 others | 1 |" ],
+			[ 7, "| *Total* | *6* |" ] ].each do |i,line|
+				assert_equal line, content[i]
+		end
+	end
+end
+
+
+class TestAuthorCountHelper < Test::Unit::TestCase
+	include TearDownableWiki
+
+	
+	def test_total_count
+		count = AuthorCountHelper.new(@wiki,'Principal Authors', :test_event, 2 ).counts
+		@wiki.revise( 'count1','1','t1')
+		@wiki.revise( 'count2','2','t2')
+		@wiki.revise( 'count3','3','t3')
+		wait_for_queue_to_empty
+		assert_equal( 3, count.total )
+	end
+		
+	def	test_author_count
+		count = AuthorCountHelper.new(@wiki,'Principal Authors', :test_event, 2 ).counts
+		@wiki.revise( 'count1','1','t1')
+		@wiki.revise( 'count2','1','t1')
+		@wiki.revise( 'count2','2','t2')
+		@wiki.revise( 'count3','1','t1')
+		@wiki.revise( 'count3','2','t2')
+		@wiki.revise( 'count3','3','t3')
+		wait_for_queue_to_empty
+		assert_equal( 3, count['t1'] )
+		assert_equal( 2, count['t2'] )
+		assert_equal( 1, count['t3'] )
+		assert_equal( 6, count.total )
+	end
+	
+	def test_page_render
+		start_time = Time.now
+		test_author_count
+		@wiki.notify( :test_event )
+		wait_for_queue_to_empty
+		content = @wiki.page('Principal Authors').content.split "\n"
+		[	[ 0, "h1. Principal Authors" ],
+			[ 4, "| t1 | 3 |" ],
+			[ 5, "| t2 | 2 |" ],
+			[ 6, "| 1 others | 1 |" ],
+			[ 7, "| *Total* | *6* |" ] ].each do |i,line|
+				assert_equal line, content[i]
+		end		
+	end
+end

data/test/test_soks-helper-maintenance.rb

@@ -0,0 +1,106 @@
+require 'test/unit'
+require 'mock-objects'
+require 'helpers/maintenance-helpers'
+
+class TestDeleteOldPages < Test::Unit::TestCase
+	include TearDownableWiki
+	
+	def setup
+		super
+		DeleteOldPagesHelper.new( @wiki, :an_event, 2 )
+	end
+	
+	def test_delete_old_pages
+		assert_equal([],files)
+		@wiki.revise( 'home page', 'hello world', 'tamc2')
+		assert_equal( true, @wiki.exists?('home page') )
+		assert_equal( false, @wiki.page('home page').deleted? )
+		assert_equal(['home%20page.textile','home%20page.yaml'],files)
+		
+		@wiki.delete( 'home page', 'tamc2')
+		@wiki.notify(:an_event )
+		wait_for_queue_to_empty
+		
+		# Should be too soon
+		assert_equal( false, @wiki.exists?('home page') )
+		assert_equal( true, @wiki.page('home page').deleted? )
+		assert_equal(['home%20page.textile','home%20page.yaml'],files)		
+		
+		sleep( 2 ) 
+		@wiki.notify(:an_event )
+		wait_for_queue_to_empty
+		
+		# Should now have deleted
+		assert_equal( false, @wiki.exists?('home page') )
+		assert_equal( false, @wiki.page('home page').deleted? )
+		assert_equal([],files)		
+	end
+	
+end
+
+class TestDeleteOldRevisions < Test::Unit::TestCase
+	include TearDownableWiki
+	
+	def setup
+		super
+		DeleteOldRevisionsHelper.new( @wiki, :an_event, 2, 2)
+	end
+	
+	def test_delete_old_revisions
+		1.upto(5) do |i|
+			@wiki.revise('revision delete test page',"#{i}","test author")
+		end
+		page = @wiki.page('revision delete test page')
+		assert_equal(5,page.revisions.size)
+		
+		@wiki.notify(:an_event )
+		wait_for_queue_to_empty
+		
+		# Should be too soon
+		assert_equal(5,page.revisions.size)
+		
+		sleep( 2 ) 
+		@wiki.notify(:an_event )
+		wait_for_queue_to_empty
+		
+		# Should now have turned last 3 revisions into one
+		assert_equal(3,page.revisions.size)
+		assert_equal('Automatic Revision Remover',page.revisions.first.author)
+		assert_equal('3',page.revisions.first.content)
+	end
+end
+
+class TestMergeOldRevisions < Test::Unit::TestCase
+	include TearDownableWiki
+	
+	def setup
+		super
+		MergeOldRevisionsHelper.new( @wiki, :an_event, 2, 10)
+	end
+	
+	def test_merge_old_revisions
+		1.upto(3) do |i|
+			@wiki.revise('revision merge test page',"#{i}","author1")
+		end
+		3.upto(5) do |i|
+			@wiki.revise('revision merge test page',"#{i}","author2")
+		end
+		page = @wiki.page('revision merge test page')
+		assert_equal(5,page.revisions.size)
+		
+		@wiki.notify(:an_event )
+		wait_for_queue_to_empty
+		
+		# Should be too soon
+		assert_equal(5,page.revisions.size)
+		
+		sleep( 2 ) 
+		@wiki.notify(:an_event )
+		wait_for_queue_to_empty
+		
+		# Should now have merged each author's revisions
+		assert_equal(2,page.revisions.size)
+		assert_equal('3',page.revision(0).content)
+		assert_equal('5',page.revision(1).content)
+	end
+end

data/test/test_soks-helpers.rb

@@ -0,0 +1,145 @@
+require 'test/unit'
+require 'fileutils'
+require 'mock-objects'
+require 'helpers/default-helpers'
+require 'generator'
+
+class TestAutomaticSummary < Test::Unit::TestCase
+	include TearDownableWiki
+	
+	def test_basics
+		AutomaticSummary.new( @wiki, 'automatic summary' ) { |page| page.name =~ /hello/i }
+		@wiki.revise 'hello world', 'hello world', 'test author'
+		@wiki.revise 'hello john', 'hello john', 'test author'
+		@wiki.revise 'hello frank', 'hello frank', 'test author'
+		@wiki.revise 'hello frank', 'page deleted', 'test author'
+		@wiki.revise 'goodbye world', 'goodbye world', 'test author'
+		wait_for_queue_to_empty
+		content = @wiki.page('automatic summary').content
+		assert_match /hello world/, content
+		assert_match /hello john/, content
+		assert_no_match /goodbye world/, content
+		assert_no_match /hello frank/, content
+	end
+	
+	def test_updates_on_revision
+		as = AutomaticSummary.new( @wiki, 'update on revision test' ) { |page| page.name =~ /summarise/i }
+		@wiki.revise('summarise 1','initial content','test author')
+		wait_for_queue_to_empty
+		assert_match(/initial content/,@wiki.page('update on revision test').content )
+		@wiki.revise('summarise 1','updated content','test author')
+		wait_for_queue_to_empty
+		assert_match(/updated content/,@wiki.page('update on revision test').content )
+	end
+
+	def test_removes_when_no_longer_true
+		AutomaticSummary.new( @wiki, 'remove when not true test' ) { |page| page.content =~ /hello/i }
+		@wiki.revise('summarise 1','hello','test author')
+		wait_for_queue_to_empty
+		assert_match(/hello/,@wiki.page('remove when not true test').content )
+		@wiki.revise('summarise 1','bye','test author')
+		wait_for_queue_to_empty
+		assert_no_match(/hello/,@wiki.page('remove when not true test').content )
+		assert_no_match(/bye/,@wiki.page('remove when not true test').content )
+	end
+
+end
+
+class TestRecentChanges < Test::Unit::TestCase
+	include TearDownableWiki
+	
+	def test_detect_change
+		rc = AutomaticRecentChanges.new( @wiki)
+		@wiki.revise( 'testpage','B','normal person')
+		@wiki.revise( 'testpage2','A','normal person')
+		wait_for_queue_to_empty
+		assert_equal(2, rc.summary.to_a.size)
+		assert_match( /normal person/i, rctextile )
+	end
+	
+	def test_merge_author_change
+		rc = AutomaticRecentChanges.new( @wiki)
+		@wiki.revise( 'testpage','B','normal person')
+		@wiki.revise( 'testpage','A','normal person')
+		wait_for_queue_to_empty
+		assert_equal(1, rc.summary.to_a.size)
+		assert_match( /normal person/i, rctextile )
+	end
+	
+	def test_dont_merge_different_authors_change
+		@rc = AutomaticRecentChanges.new( @wiki)
+		@wiki.revise( 'testpage','B','p1')
+		@wiki.revise( 'testpage','A','p2')
+		wait_for_queue_to_empty
+		assert_equal(2, @rc.summary.to_a.size)
+		assert_match( /p1/i, rctextile )
+		assert_match( /p2/i, rctextile )
+	end
+	
+	def test_exclude_helpers_initially
+		@wiki.revise( 'testpage','B','normal person')
+		@wiki.revise( 'testpage2','content moved from','AutomaticPageMover')
+		@wiki.revise( 'testpage2','A','normal person')
+		rc = AutomaticRecentChanges.new( @wiki)
+		assert_equal(['recent changes to this site','testpage','testpage2'],@wiki.map{|name,page| name }.sort)
+		assert_equal(2, rc.summary.to_a.size)
+		assert_match( /normal person/i, rctextile )
+		assert_no_match( /AutomaticPageMover/i, rctextile )
+	end
+	
+	def test_exclude_helpers_later
+		rc = AutomaticRecentChanges.new( @wiki)
+		@wiki.revise( 'testpage','B','normal person')
+		@wiki.revise( 'testpage2','content moved from','AutomaticPageMover')
+		@wiki.revise( 'testpage2','A','normal person')
+		wait_for_queue_to_empty
+		assert_equal(['recent changes to this site','testpage','testpage2'],@wiki.map{|name,page| name }.sort)
+		assert_equal(2, rc.summary.to_a.size)
+		assert_match( /normal person/i, rctextile )
+		assert_no_match( /AutomaticPageMover/i, rctextile )
+	end
+	
+	def test_change_in_page_capitalisation
+		rc = AutomaticRecentChanges.new( @wiki)
+		@wiki.revise( 'testpage','B','normal person')
+		wait_for_queue_to_empty
+		assert_match( /\[\[testpage\]\]/, rctextile )
+		assert_no_match( /\[\[TestPage\]\]/, rctextile )
+		@wiki.revise( 'TestPage','C','normal person')
+		wait_for_queue_to_empty
+		assert_match( /\[\[TestPage\]\]/, rctextile )
+		assert_equal( 1, count_matches(  /\[\[TestPage\]\]/ ) )
+	end
+	
+	private
+	
+	def count_matches( regexp )
+		count = 0
+		rctextile.gsub( regexp ) { |m| count += 1 }
+		count
+	end
+	
+	def rctextile
+		@wiki.page("Recent Changes to This Site").textile 
+	end	
+end
+
+class TestCalendar < Test::Unit::TestCase
+	include TearDownableWiki
+	
+	def setup
+		super
+		AutomaticCalendar.new( @wiki )
+		AutomaticUpdateCrossLinks.new( @wiki, @view )
+	end
+	
+	def test_2006_Mar_html
+		wait_for_queue_to_empty
+		page = @wiki.page('2006 Mar')
+		desired_html = IO.readlines('test/html/2006Mar.html')
+		actual_html = @view.redcloth( page ).split("\n").map { |l| "#{l}\n" }
+		SyncEnumerator.new(desired_html,actual_html).each do |desired,actual|
+			assert_equal( desired, actual )
+		end
+	end 
+end