wikilink-converter 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -0,0 +1,23 @@
+source 'http://rubygems.org'
+require 'rbconfig'
+HOST_OS = RbConfig::CONFIG['host_os']
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec'
+  gem 'yard'
+  gem 'bundler'
+  gem 'jeweler'
+  gem 'simplecov'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'guard-yard'
+  gem 'redcarpet'
+
+  if HOST_OS =~ /linux/i
+    gem 'rb-inotify', require: false
+    gem 'libnotify', require: false
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    git (1.2.5)
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-rspec (0.5.8)
+      guard (>= 0.8.4)
+    guard-yard (1.0.2)
+      guard (>= 0.2.2)
+      yard (>= 0.7.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    libnotify (0.5.9)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    redcarpet (1.17.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    thor (0.14.6)
+    yard (0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  guard
+  guard-bundler
+  guard-rspec
+  guard-yard
+  jeweler
+  libnotify
+  rb-inotify
+  redcarpet
+  rspec
+  simplecov
+  yard

data/Guardfile

@@ -0,0 +1,21 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => '--color --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})  { "spec" }
+end
+
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end
+
+guard 'yard' do
+  watch(%r{lib/.+\.rb})
+  watch('README.markdown')
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ian Yang
+
+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.markdown

@@ -0,0 +1,14 @@
+wikilink-converter
+==================
+
+Description goes here.
+
+[![Build Status](https://secure.travis-ci.org/doitian/wikilink-converter.png)](http://travis-ci.org/doitian/wikilink-converter)
+
+
+Copyright
+---------
+
+Copyright (c) 2011 Ian Yang. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "wikilink-converter"
+  gem.homepage = "http://github.com/doitian/wikilink-converter"
+  gem.license = "MIT"
+  gem.summary = %Q{convert [[WikiLink]] to <a>}
+  gem.description = %Q{convert [[WikiLink]] to <a>}
+  gem.email = "me@iany.me"
+  gem.authors = ["Ian Yang"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :cov do
+  system 'bundle exec rake COVERAGE=1 spec'
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/wikilink/converter/namespace.rb

@@ -0,0 +1,58 @@
+require 'wikilink/converter/utils'
+
+module Wikilink
+  class Converter
+    # Namespace converter
+    class Namespace
+      include LinkHelper
+
+      DEFAULT_NAME = ''
+
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def config(&block)
+        @block = block
+        self
+      end
+
+      def run(colon, path, name, current_page)
+        if @block
+          instance_exec(colon, path, name, current_page, &@block)
+        end
+      end
+
+      class Default < Namespace
+        def run(colon, path, name, current_page)
+          return super if @block
+
+          path, fragment = path.split('#', 2)
+          path, query = path.split('?', 2)
+
+          fragment = '#' + fragment if fragment
+          query = '?' + query if query
+
+          url = to_url(path, fragment, query)
+
+          link_to(name, url, :class => html_class)
+        end
+
+        def to_url(path, fragment, query)
+          if path.nil? || path.empty?
+            [query, fragment].join
+          else
+            [options[:prefix], path, options[:suffix], query, fragment].join
+          end
+        end
+      end
+
+      protected
+      def html_class
+        [options[:class], ('external' if options[:external])]
+      end
+    end
+  end
+end

data/lib/wikilink/converter/site.rb

@@ -0,0 +1,99 @@
+require 'wikilink/converter/namespace'
+require 'wikilink/converter/utils'
+
+module Wikilink
+  class Converter
+    # Site converter
+    class Site
+      include ArgumentExtractor
+      CURRENT_SITE_NAME = ''
+      DEFAULT_NAMESPACE = ::Wikilink::Converter::Namespace::DEFAULT_NAME
+
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+        is_current_site = @options[:name].to_s == CURRENT_SITE_NAME
+        @options[:external] = !is_current_site unless @options.key?(:external)
+        @options[:prefix] ||= '/' if is_current_site
+        @namespace_converters = {}
+
+        on_namespace(DEFAULT_NAMESPACE)
+        
+        yield self if block_given?
+      end
+
+      def on_namespace(*args, &block)
+        namespace, converter, options = extract_arguments(*args)
+        namespace = DEFAULT_NAMESPACE if namespace.to_s.empty?
+        
+        converter ||= namespace_converter(namespace)
+        if converter.nil?
+          # do not add new handler if there's a instance method can handle it,
+          # except that user passes a block to override it
+          if block || instance_method_converter(namespace).nil?
+            converter = ::Wikilink::Converter::Namespace
+            converter = ::Wikilink::Converter::Namespace::Default if !block && namespace == DEFAULT_NAMESPACE
+          end
+        end
+
+        if converter.is_a?(Class)
+          options = default_options_for_namespace.merge(options)
+          options[:name] ||= namespace
+          converter = converter.new(options)
+        end
+
+        if converter.respond_to?(:config) && block
+          converter.config(&block)
+        end
+
+        set_namespace_converter namespace, converter if converter
+        self
+      end
+      alias_method :on, :on_namespace
+      alias_method :namespace, :on_namespace
+
+      def on_default_namespace(*args, &block)
+        on_namespace(DEFAULT_NAMESPACE, *args, &block)
+      end
+      alias_method :default_namespace, :on_default_namespace
+
+      def run(colon, namespace, path, name, current_page)
+        if converter = namespace_converter(namespace)
+          converter.run(colon, path, name, current_page)
+        elsif converter = instance_method_converter(namespace)
+          converter.call(colon, path, name, current_page)
+        end
+      end
+
+      protected
+      def html_class
+        [options[:class], ('external' if options[:external])]
+      end
+
+      private
+      def namespace_converter(namespace)
+        namespace = namespace.to_s.downcase
+        @namespace_converters[namespace]
+      end
+
+      def instance_method_converter(namespace)
+        namespace = namespace.to_s.downcase
+        try_message = "on_namespace_#{namespace}".to_sym
+        method(try_message) if respond_to?(try_message)
+      end
+
+      def set_namespace_converter(namespace, converter)
+        @namespace_converters[namespace] = converter
+      end
+      
+      def default_options_for_namespace
+        opts = @options.dup
+        opts.delete :name
+        opts[:site_name] = @options[:name]
+
+        opts
+      end
+    end
+  end
+end

data/lib/wikilink/converter/sites/ruby_china.rb

@@ -0,0 +1,43 @@
+require 'wikilink/converter/site'
+require 'wikilink/converter/utils'
+
+module Wikilink
+  class Converter
+    module Sites
+      class RubyChina < Wikilink::Converter::Site
+        include Wikilink::Converter::LinkHelper
+
+        def initialize(options = {})
+          if options[:name] == CURRENT_SITE
+            options[:domain] ||= '/'
+          else
+            options[:domain] ||= 'http://ruby-china.org/'
+          end
+          options[:prefix] = "#{options[:domain]}wiki/"
+
+          super(options)
+        end
+
+        def on_namespace_topic(colon, path, name, current_page)
+          path = "#{options[:domain]}topics/#{path}"
+          link_to name, path, :class => html_class
+        end
+
+        def on_namespace_node(colon, path, name, current_page)
+          path = "#{options[:domain]}topics/node#{path}"
+          link_to name, path, :class => html_class
+        end
+      end
+
+      class RubyTaiwan < RubyChina
+        def initialize(options = {})
+          if options[:name] != CURRENT_SITE
+            options[:domain] ||= 'http://ruby-taiwan.org/'
+          end
+
+          super(options)
+        end
+      end
+    end
+  end
+end

data/lib/wikilink/converter/sites/wikipedia.rb

@@ -0,0 +1,20 @@
+require 'wikilink/converter/site'
+
+module Wikilink
+  class Converter
+    module Sites
+      class Wikipedia < Wikilink::Converter::Site
+        def initialize(options = {})
+          options[:lang] ||= 'en'
+          if options[:name] == CURRENT_SITE
+            options[:prefix] ||= '/wiki/'
+          else
+            options[:prefix] ||= "http://#{options[:lang]}.wikipedia.org/wiki/"
+          end
+
+          super(options)
+        end
+      end
+    end
+  end
+end

data/lib/wikilink/converter/utils.rb

@@ -0,0 +1,37 @@
+require 'cgi'
+
+module Wikilink
+  class Converter
+    module ArgumentExtractor
+      def extract_arguments(*args)
+        options = {}
+        options = args.pop if args.last.is_a?(Hash)
+        name = args.shift
+
+        if name.nil? || name.is_a?(String) || name.is_a?(Symbol)
+          name = name.to_s
+          converter = args.shift
+        else
+          converter = name
+          name = nil
+        end
+
+        throw ArgumentError, "too many arguments" unless args.empty?
+
+        [name, converter, options]
+      end
+    end
+
+    module LinkHelper
+      def link_to(name, url, attributes = {})
+        attributes[:class] = Array(attributes[:class]).flatten.join(' ').split.uniq.join(' ')
+        attributes.delete(:class) if attributes[:class].empty?
+        attributes = attributes.inject('') do |memo, (key, value)|
+          memo + key.to_s + '="' + CGI.escape_html(value) + '" '
+        end
+
+        "<a #{attributes}href=\"#{CGI.escape_html url}\">#{CGI.escape_html name}</a>"
+      end
+    end
+  end
+end

data/lib/wikilink/converter.rb

@@ -0,0 +1,173 @@
+require 'forwardable'
+require 'wikilink/converter/site'
+require 'wikilink/converter/utils'
+
+module Wikilink
+  # Convert `[[Wikilink]]` to HTML
+  #
+  # The real work is handed over to registered handlers through {#on}.
+  #
+  # The parsing rules
+  # -----------------
+  #
+  # - `[[Wikilink]]` should be in one line, otherwise it is ignored.
+  # - `\[[Wikilink]]` is escaped and converted to `[[Wikilink]]`.
+  # - `[[action:arg]]` triggers handler registered on **action**. **arg** is passed as
+  #   first argument to the handler. **arg** can contains colons.
+  # - `[[:action:arg]]` is the same with `[[action:arg]]`, except that `true` is
+  #   passed as the second argument to handler to indicate a prefix colon
+  #   exists. It is useful for resources like image, where no colon version
+  #   inserts the image and colon version inserts the link.
+  # - `[[Wikilink]]` is identical with `[[page:Wikilink]]`, i.e., the default
+  #   action is **page**.
+  class Converter
+    extend Forwardable
+    include ArgumentExtractor
+    CURRENT_SITE = ::Wikilink::Converter::Site::CURRENT_SITE_NAME
+
+    # Setup a converter. Handlers can be registered in block directly. If no
+    # handler is registered on **page**, a default handler
+    # Wikilink::Converter::Page is created with the given `options`.
+    #
+    # @param [Hash] options options for Wikilink::Converter::Page
+    def initialize(options = {})
+      @site_converts = {}
+      @action_handlers = {}
+      @options = options
+
+      on_site(CURRENT_SITE, @options)
+      yield self if block_given?
+    end
+
+    def run(text, current_page = nil)
+      text.gsub(/(^|.)\[\[(.*?[^:])\]\]/) do |match|
+        prefix, inner = $1, $2.strip
+        if prefix == '\\'
+          match[1..-1]
+        else
+          if inner.start_with?(':')
+            colon = ':'
+            inner = inner[1..-1]
+          end
+          link, name = inner.split('|', 2)
+          path, namespace, site = link.split(':', 3).reverse
+
+          if site.to_s.empty? && !namespace.to_s.empty?
+            # if namespace is a valid site name, use it as site
+            if site_converter(namespace)
+              site = namespace
+              namespace = nil
+            end
+          end
+          
+          if name.to_s.empty?
+            name = resolve_name(inner, current_page)
+          end
+
+          # ignore malformed wikilink
+          if valid?(site, namespace, path)
+            result = convert_link(colon, site, namespace, path, name, current_page)
+            result ? ($1 + result) : match
+          else
+            match
+          end
+        end
+      end
+    end
+
+    def execute(text)
+      text.gsub(/(^|.)\{\{(.*?[^:])\}\}/) do |match|
+        prefix, inner = $1, $2.strip
+        if prefix == '\\'
+          match[1..-1]
+        else
+          action, arg = inner.split(':', 2)
+          result = convert_action(action, arg)
+          result ? ($1 + result) : match
+        end
+      end
+    end
+
+    def_delegator :@current_site_converter, :on_namespace
+    alias_method :on, :on_namespace
+    alias_method :namespace, :on_namespace
+
+    def_delegator :@current_site_converter, :on_default_namespace
+    alias_method :default_namespace, :on_default_namespace
+
+    def on_site(*args)
+      site, converter, options = extract_arguments(*args)
+      options = @options.merge(options)
+      site = CURRENT_SITE if site.to_s.empty?
+
+      converter ||= site_converter(site) || Wikilink::Converter::Site
+      if converter.is_a?(Class)
+        options[:name] ||= site
+        converter = converter.new(options)
+      end
+
+      yield converter if block_given?
+
+      set_site_converter site, converter
+      self
+    end
+    alias_method :site, :on_site
+
+    def on_current_site(*args, &block)
+      on_site(CURRENT_SITE, *args, &block)
+    end
+    alias_method :current_site, :on_current_site
+
+    def on_action(action, &block)
+      @action_handlers[action.to_s.downcase] = block
+      self
+    end
+    alias_method :action, :on_action
+
+
+    private
+    def site_converter(site)
+      site = site.to_s.downcase
+      site == CURRENT_SITE ? @current_site_converter : @site_converts[site]
+    end
+
+    def set_site_converter(site, converter)
+      site = site.to_s.downcase
+      if site == CURRENT_SITE
+        @current_site_converter = converter
+      else
+        @site_converts[site] = converter
+      end
+    end
+    
+    def convert_action(action, argument)
+      handler = @action_handlers[action.to_s.downcase]
+      handler.call(argument) if handler
+    end
+
+    def convert_link(colon, site, namespace, path, name, current_page)
+      converter = site_converter(site)
+      converter.run(colon, namespace, path, name, current_page) if converter
+    end
+
+    # TODO: relative
+    # TODO: ruby (computer) -> ruby
+    # TODO: Shanghai, China -> Shanghai
+    def resolve_name(inner_text, current_path)
+      if inner_text.end_with?('|')
+        inner_text.chop.chomp('/').split(%r{[:/]}, 2).last
+      else
+        inner_text
+      end
+    end
+
+    INVALID_NAME_REGEXP = /[^[[:alnum:]][[:blank]]_-]/
+    INVALID_PATH_REGEXP = /^[\[\]]/
+    def valid?(site, namespace, path)
+      return false if site =~ INVALID_NAME_REGEXP
+      return false if namespace =~ INVALID_NAME_REGEXP
+      return false if path =~ INVALID_PATH_REGEXP
+      return true
+    end
+  end
+end

data/lib/wikilink-converter.rb

@@ -0,0 +1 @@
+require 'wikilink/converter'

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require 'rspec'
+require 'wikilink-converter'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end