WatersOfOblivion-wikipodia 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,83 @@
+=Wikipodia
+
+Wikipodia is a DSL for defining wikis within a Controller.  It contains a small
+preprocessor which recognizes links within text and converts them to user
+defined formats.  It allows a way to define these formats and a way in which to
+display content being linked to.
+
+==A Simple Example
+
+For example, a simple wiki which just has pages processed with RedCloth:
+
+  class FooController < ActionController::Base
+    wikipodia do
+      # Define a link to another page
+      section :page do
+        # Define what to do when one of the links is clicked
+        action do
+          @page = Page.find(params[:id])
+          render :text => RedCloth.new(handle_wiki_links(@page.content)).to_html
+        end
+
+        # Define how to transform the link
+        url do |id, text|
+          "\"#{text}\":#{page_path(id)}"
+        end
+      end
+    end
+  end
+
+Anywhere in <tt>@page.content</tt>, links of the format
+<tt>[[page:some-id Some Text]]</tt> will be converted into RedCloth links of the
+format <tt>"Some Text":/page/some-id</tt>.
+
+==A More Complex Example
+
+A more complete wiki might support not only pages, but images and file
+downloads:
+
+  class MiniWikiController < ActionController::Base
+    wikipodia do
+      section :page do
+        action do
+          @page = Page.find(params[:id])
+          render :text => RedCloth.new(handle_wiki_links(@page.content)).to_html
+        end
+
+        url do |id, text|
+          "\"#{text}\":#{page_path(id)}"
+        end
+      end
+
+      section :image do
+        action do
+          @image = Image.find(params[:id])
+          send_data @image.content
+        end
+
+        url do |id, text|
+          "!#{image_path(id)}!"
+        end
+      end
+
+      section :document do
+        action do
+          @document = Documents.find(params[:id])
+          send_data @document.content, :filename => @document.original_filename, :type => @document.content_type
+        end
+
+        url do |id, text|
+          "\"#{text}\":#{document_path(id)}"
+        end
+      end
+    end
+  end
+
+==Gem
+
+This plugin is available as a Gem.  To use it, simply add the following line to
+your <tt>config/environment.rb</tt> and run <tt>rake gems:install</tt>:
+
+  config.gem "WatersOfOblivion-wikipodia", :lib => "wikipodia", :source => "http://gems.github.com/"
+
+Copyright (c) 2009 Jonathan Bryant, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the wikipodia plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the wikipodia plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Wikipodia'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,2 @@
+
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/wikipodia.rb

@@ -0,0 +1,56 @@
+# Wikipodia
+
+module Wikipodia
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+  
+  module ClassMethods
+    def wikipodia options = {}, &definition
+      instance_eval do
+        define_method :handle_wiki_links do |text|
+          text.gsub /\[\[([-\w\d]+):([-\w\d]+)\s+(.*)\]\]/ do |link|
+            send "handle_#{$1}_link".to_sym, $2, $3
+          end
+        end
+        protected :handle_wiki_links
+      end
+    
+      @wikipodia = Wikipodia.new(self)
+      @wikipodia.instance_eval &definition if definition
+    end
+  end
+
+  class Wikipodia
+    def initialize(controller)
+      @controller = controller
+      @sections ||= {}
+    end
+    
+    def section name, options = {}, &definition
+      @sections[name] = Section.new(@controller, name)
+      @sections[name].instance_eval &definition if definition
+    end
+  end
+  
+  class Section
+    def initialize(controller, name)
+      @controller = controller
+      @name = name
+    end
+    
+    def action options = {}, &body
+      name = @name
+      @controller.instance_eval do
+        define_method name, &body if body
+      end
+    end
+    
+    def url options = {}, &handler
+      name = "handle_#{@name}_link".to_sym
+      @controller.instance_eval do
+        define_method name, &handler if handler
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+# Include hook code here
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'wikipodia')
+ActionController::Base.send :include, Wikipodia

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'test/unit'
+require 'action_controller'
+require 'action_controller/test_process'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'wikipodia')

data/test/wikipodia_test.rb

@@ -0,0 +1,121 @@
+require 'test_helper'
+
+ActionController::Base.send :include, Wikipodia
+
+class WikipodiaTest < Test::Unit::TestCase
+  def test_action_controller_contains_wikipodia_method
+    assert_respond_to ActionController::Base, :wikipodia
+  end
+  
+  def test_wikipodia_method_creates_a_protected_wiki_link_handler_method
+    ActionController::Base.wikipodia
+    assert ActionController::Base.new.protected_methods.include? "handle_wiki_links"
+  end
+  
+  def test_wikipodia_wiki_link_handler_method_follows_defined_sections
+    ActionController::Base.wikipodia do
+      section "test-section" do
+        url do |id, text|
+          "\"#{text}\":#{id}"
+        end
+      end
+    end    
+    assert_equal "\"Some Text\":12345", ActionController::Base.new.send(:handle_wiki_links, "[[test-section:12345 Some Text]]")
+  end
+  
+  def test_wikipodia_takes_and_executes_block
+    assert_raises RuntimeError do
+      ActionController::Base.wikipodia do
+        raise "I take and execute a block"
+      end
+    end
+  end
+  
+  def test_wikipodia_block_has_section_method
+    assert_nothing_raised NoMethodError do
+      ActionController::Base.wikipodia do
+        section :section_name
+      end
+    end
+  end
+  
+  def test_wikipodia_section_block_takes_and_executes_block
+    assert_raises RuntimeError do
+      ActionController::Base.wikipodia do
+        section :section_name do
+          raise "I take and execute a block"
+        end
+      end
+    end
+  end
+  
+  def test_wikipodia_section_block_has_url_method
+    assert_nothing_raised NoMethodError do
+      ActionController::Base.wikipodia do
+        section :section_name do
+          url
+        end
+      end
+    end
+  end
+  
+  def test_wikipodia_section_url_method_takes_a_block
+    assert_nothing_raised ArgumentError do
+      ActionController::Base.wikipodia do
+        section :section_name do
+          url do
+          end
+        end
+      end
+    end
+  end
+  
+  def test_wikipodia_section_url_method_defines_a_protected_handler_method_with_the_block
+    ActionController::Base.wikipodia do
+      section :section_name do
+        url do |id, text|
+          "\"#{text}\":#{id}"
+        end
+      end
+    end
+    
+    assert_respond_to ActionController::Base.new, :handle_section_name_link
+    assert_equal "\"bar\":foo", ActionController::Base.new.handle_section_name_link("foo", "bar")
+  end
+  
+  def test_wikipodia_section_block_has_action_method
+    assert_nothing_raised NoMethodError do
+      ActionController::Base.wikipodia do
+        section :section_name do
+          action
+        end
+      end
+    end
+  end
+  
+  def test_wikipodia_section_action_method_takes_a_block
+    assert_nothing_raised ArgumentError do
+      ActionController::Base.wikipodia do
+        section :section_name do
+          action do
+          end
+        end
+      end
+    end
+  end
+  
+  def test_wikipodia_section_action_method_defines_a_public_action_with_the_block
+    ActionController::Base.wikipodia do
+      section :section_name do
+        action do
+          raise "I'm the public action"
+        end
+      end
+    end
+    
+    assert_respond_to ActionController::Base.new, :section_name
+    assert_raises RuntimeError do
+      ActionController::Base.new.section_name
+    end
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: WatersOfOblivion-wikipodia
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonathan Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-05 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: watersofmemory@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- init.rb
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- uninstall.rb
+- rails/init.rb
+- test/wikipodia_test.rb
+- test/test_helper.rb
+- lib/wikipodia.rb
+has_rdoc: true
+homepage: http://watersofoblivion.github.com/wikipodia/
+post_install_message: 
+rdoc_options: 
+- --title
+- Wikipodia
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails plugin for easy links in RedCloth
+test_files: 
+- test/wikipodia_test.rb
+- test/test_helper.rb