wikilink-converter 0.1.0

data/spec/support/matchers.rb

@@ -0,0 +1,43 @@
+RSpec::Matchers.define :convert do |*from|
+  from_description = from
+  from_description = nil if from.empty?
+  from_description = from.first if from.size == 1
+  
+  diffable
+
+  define_method :actual do
+    @real_actual ||= @actual.call(*from)
+  end
+
+  def expected
+    [@to]
+  end
+
+  match do |method|
+    actual == @to
+  end
+
+  description do
+    "convert #{from_description.inspect} to #{@to.inspect}"
+  end
+
+  failure_message_for_should do |method|
+    <<MESSAGE
+expected #{from_description.inspect}
+      to #{@to.inspect}
+     got #{actual.inspect}
+MESSAGE
+  end
+
+  failure_message_for_should_not do |method|
+    <<MESSAGE
+expected #{from_description.inspect}
+  not to #{@to.inspect}
+     got #{actual.inspect}
+MESSAGE
+  end
+
+  chain :to do |to|
+    @to = to
+  end
+end

data/spec/wikilink/converter/namespace_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+shared_examples 'converter that can forward to given block' do |klass|
+  klass ||= describes
+
+  context 'given block through #config' do
+    let(:converter) { klass.new.config { 'it works' } }
+
+    describe '#run' do
+      subject { converter.method(:run) }
+      it 'forwards to the block' do
+        subject.should convert(':', 'Home', 'Home', '/').to('it works')
+      end
+    end
+  end
+
+  context 'given block accessing options in constructor through #config' do
+    let(:converter) {
+      klass.new(fake_result: 'fake').config { options[:fake_result] }
+    }
+
+    describe '#run' do
+      subject { converter.method(:run) }
+      it 'forwards to the block and allows options access' do
+        subject.should convert(':', 'Home', 'Home', '/').to('fake')
+      end
+    end
+  end
+end
+
+describe Wikilink::Converter::Namespace do
+  let(:converter) { Wikilink::Converter::Namespace.new }
+  describe '#run' do
+    subject { converter.method(:run) }
+    it 'does nothing' do
+      subject.should convert(':', 'Home', 'Home', '/').to(nil)
+    end
+  end
+
+  it_behaves_like 'converter that can forward to given block'
+end
+
+describe Wikilink::Converter::Namespace::Default do
+  shared_examples 'converter that keeps query fragment only path untouched' do
+    it { should convert(':', '#toc-1', 'Header 1', '/').
+      to('<a href="#toc-1">Header 1</a>')
+    }
+    it { should convert(':', '?q=keyword', 'Search keyword', '/').
+      to('<a href="?q=keyword">Search keyword</a>')
+    }
+    it { should convert(':', '?q=keyword#page-10', 'Search keyword (page 10)', '/').
+      to('<a href="?q=keyword#page-10">Search keyword (page 10)</a>')
+    }
+  end
+
+  let(:converter) { self.class.describes.new }
+  describe '#run' do
+    subject { converter.method(:run) }
+    it { should convert(':', 'Home', 'Name', '/').
+      to('<a href="Home">Name</a>')
+    }
+    it_behaves_like 'converter that keeps query fragment only path untouched'
+  end
+
+  context 'given option :prefix "/wiki/"' do
+    let(:converter) { self.class.describes.new prefix: '/wiki/' }
+    describe '#run' do
+      subject { converter.method(:run) }
+      it_behaves_like 'converter that keeps query fragment only path untouched'
+    end
+  end
+
+  context 'given option :suffix "/index.html"' do
+    let(:converter) { self.class.describes.new suffix: '/index.html' }
+    describe '#run' do
+      subject { converter.method(:run) }
+      it { should convert(':', 'Home', 'Name', '/').
+        to('<a href="Home/index.html">Name</a>')
+      }
+      it_behaves_like 'converter that keeps query fragment only path untouched'
+    end
+  end
+
+  context 'given option :external true' do
+    let(:converter) { self.class.describes.new external: true }
+    describe '#run' do
+      subject { converter.method(:run) }
+      it { should convert(':', 'Home', 'Name', '/').
+        to('<a class="external" href="Home">Name</a>')
+      }
+    end
+  end
+  context 'given option :class "fancy"' do
+    let(:converter) { self.class.describes.new class: 'fancy' }
+    describe '#run' do
+      subject { converter.method(:run) }
+      it { should convert(':', 'Home', 'Name', '/').
+        to('<a class="fancy" href="Home">Name</a>')
+      }
+    end
+  end
+  context 'given option :external true and :class "fancy"' do
+    let(:converter) { self.class.describes.new external: true, class: 'fancy' }
+    describe '#run' do
+      subject { converter.method(:run) }
+      it { should convert(':', 'Home', 'Name', '/').
+        to('<a class="fancy external" href="Home">Name</a>')
+      }
+    end
+  end
+
+  it_behaves_like 'converter that can forward to given block'
+end

data/spec/wikilink/converter/site_spec.rb

@@ -0,0 +1,334 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe Wikilink::Converter::Site do
+  DEFAULT_NAMESPACE = Wikilink::Converter::Site::DEFAULT_NAMESPACE
+  CURRENT_SITE_NAME = Wikilink::Converter::Site::CURRENT_SITE_NAME
+
+  # { subject.foo }.should forward(:bar).to(handler).with(any_args)
+  RSpec::Matchers.define :forward do |message|
+    match do |block|
+      block.call
+      @handler.received_message?(message, *@arguments)
+    end
+
+    description do
+      "forward to message #{message} to #{@handler.inspect}"
+    end
+
+    failure_message_for_should do |block|
+      <<MESSAGE
+expected forward #{message}
+      to #{block}
+    with #{@arguments.inspect}
+MESSAGE
+    end
+
+    failure_message_for_should_not do |block|
+      <<MESSAGE
+expected not forward #{message}
+      to #{block}
+    with #{@arguments.inspect}
+MESSAGE
+    end
+
+    chain :with do |*arguments|
+      @arguments = arguments
+    end
+
+    chain :to do |handler|
+      @handler = handler
+    end
+  end
+
+  shared_examples 'configuring a new instance of class as namespace handler' do |namespace|
+    # require setting converter to an instance of Site
+    context 'with converter class' do
+      class SpecNamespace; end
+      define_method :call do |*args|
+        if namespace.to_s.empty?
+          converter.on_namespace SpecNamespace, *args
+        else
+          converter.on_namespace namespace, SpecNamespace, *args
+        end
+      end
+      let(:namespace_converter) { double(:namespace_converter) }
+
+      it 'creates a new instance of the specified class' do
+        SpecNamespace.should_receive(:new).once
+        call
+      end
+
+      it 'uses the instance of the class as new namespace converter' do
+        SpecNamespace.should_receive(:new).once.and_return(namespace_converter)
+        call
+        namespace_converter.should_receive(:run).and_return('it works')
+        converter.run(':', namespace, 'Home', 'Name', '/').should eq('it works')
+      end
+
+      context 'and options' do
+        let(:options) { { foo: :bar} }
+        it 'creates a new instance of the specified class and options' do
+          SpecNamespace.should_receive(:new).once
+          call options
+        end
+
+        it 'initializes the new instance of the specified class with options' do
+          SpecNamespace.should_receive(:new).with(hash_including(foo: :bar)).once
+          call options
+        end
+      end
+    end
+  end
+
+  let(:default_namespace) { double(:default_namespace).as_null_object }
+  let(:namespace) { double(:namespace).as_null_object }
+  before { Wikilink::Converter::Namespace::Default.stub(:new) { default_namespace } }
+
+  shared_examples ''
+  
+  context 'current site' do
+    let(:site_name) { CURRENT_SITE_NAME }
+    let(:converter) { Wikilink::Converter::Site.new name: site_name }
+
+    describe '#initialize' do
+      def initialize_site(&block)
+        Wikilink::Converter::Site.new name: site_name, &block
+      end
+
+      it 'sets option :prefix to "/"' do
+        converter.options[:prefix].should eq('/')
+      end
+      it 'sets option :external to false' do
+        converter.options[:external].should be_false
+      end
+      it 'sets up default namespace with option :site_name' do
+        klass = Wikilink::Converter::Namespace::Default
+        klass.should_receive(:new).with(hash_including(site_name: site_name))
+        initialize_site
+      end
+      it 'sets up default namespace with option :name' do
+        klass = Wikilink::Converter::Namespace::Default
+        klass.should_receive(:new).with(hash_including(name: DEFAULT_NAMESPACE))
+        initialize_site
+      end
+      it 'yields self' do
+        initialize_site do |arg|
+          arg.should be_a_kind_of(Wikilink::Converter::Site)
+        end
+      end
+
+      context 'with option :external true' do
+        let(:converter) { Wikilink::Converter::Site.new name: site_name, external: true }
+        it 'leaves option :external as true' do
+          converter.options[:external].should be_true
+        end
+      end
+      context 'with option :prefix "/wiki/"' do
+        let(:converter) { Wikilink::Converter::Site.new name: site_name, prefix: '/wiki/' }
+        it 'leaves option :prefix as "/wiki/"' do
+          converter.options[:prefix].should eq('/wiki/')
+        end
+      end
+    end
+
+    describe '#run' do
+      it 'delegates default namespace to Namespace::Default instance' do
+        ->{ converter.run(':', DEFAULT_NAMESPACE, 'Home', 'Name', '/') }.
+          should forward(:run).to(default_namespace).with(':', 'Home', 'Name', '/')
+      end
+    end
+
+    describe '#on_default_namespace' do
+      it 'is a shortcut of #on_namespace' do
+        converter.should_receive(:on_namespace).with(DEFAULT_NAMESPACE, 'arg')
+        converter.on_default_namespace 'arg'
+      end
+    end
+
+    describe '#on_namespace' do
+      context 'without any arguments nor block' do
+        let(:default_namespace) { double(:default_namespace) }
+
+        it 'does not change the default namespace handler' do
+          Wikilink::Converter::Namespace::Default.should_receive(:new).
+            once.and_return(default_namespace)
+          converter.on_namespace
+        end
+      end
+
+      context 'with block' do
+        it 'configures default namespace with the block' do
+          yielded = double('yielded')
+          yielded.should_receive(:poke)
+          default_namespace.should_receive(:config).and_yield
+          converter.on_namespace do
+            yielded.poke
+          end
+        end
+      end
+
+      context 'with options' do
+        let(:default_namespace) { double(:default_namespace) }
+
+        it 'does not change the default namespace handler' do
+          Wikilink::Converter::Namespace::Default.should_receive(:new).
+            once.and_return(default_namespace)
+          converter.on_namespace foo: :bar
+        end
+      end
+
+      context 'with default namespace name' do
+        let(:default_namespace) { double(:default_namespace) }
+
+        it 'does not change the default namespace handler' do
+          Wikilink::Converter::Namespace::Default.should_receive(:new).
+            once.and_return(default_namespace)
+          converter.on_namespace(DEFAULT_NAMESPACE)
+        end
+      end
+      context 'with other namespace name' do
+        let(:name) { 'topics' }
+        let(:klass) { Wikilink::Converter::Namespace }
+
+        it 'creates a new Wikilink::Converter::Namespace instance' do
+          klass.should_receive(:new)
+          converter.on_namespace name
+        end
+        it 'initializes Wikilink::Converter::Namespace instance with option :site_name' do
+          klass.should_receive(:new).with(hash_including(site_name: site_name))
+          converter.on_namespace name
+        end
+        it 'initializes Wikilink::Converter::Namespace instance with option :name' do
+          klass.should_receive(:new).with(hash_including(name: name))
+          converter.on_namespace name
+        end
+        it 'uses the instance of Wikilink::Converter::Namespace as new namespace converter' do
+          klass.should_receive(:new).and_return(namespace)
+          converter.on_namespace name
+          namespace.should_receive(:run).and_return('it works')
+          converter.run(':', name, 'Home', 'Name', '/').should eq('it works')
+        end
+
+        context 'with object' do
+          it 'uses that object as new namespace converter' do
+            converter.on_namespace name, namespace
+            namespace.should_receive(:run).and_return('it works')
+            converter.run(':', name, 'Home', 'Name', '/').should eq('it works')
+          end
+        end
+
+        it_behaves_like 'configuring a new instance of class as namespace handler', 'topics'
+      end
+
+      it_behaves_like 'configuring a new instance of class as namespace handler'
+      
+      context 'with object' do
+        it 'uses that object as new namespace converter' do
+          converter.on_namespace namespace
+          namespace.should_receive(:run).and_return('it works')
+          converter.run(':', DEFAULT_NAMESPACE, 'Home', 'Name', '/').should eq('it works')
+        end
+      end
+
+      context 'with namespace, classname and options' do
+      end
+    end
+  end
+
+  context 'external site' do
+    let(:name) { 'wikipedia' }
+    let(:converter) { Wikilink::Converter::Site.new name: name }
+
+    describe '#initialize' do
+      alias_method :initialize_site, :converter
+
+      it 'does not set option :prefix' do
+        converter.options[:prefix].should be_nil
+      end
+      it 'sets option :external to true' do
+        converter.options[:external].should be_true
+      end
+
+      it 'sets up default namespace with option :site_name' do
+        klass = Wikilink::Converter::Namespace::Default
+        klass.should_receive(:new).with(hash_including(site_name: name))
+        initialize_site
+      end
+      it 'sets up default namespace with option :name' do
+        klass = Wikilink::Converter::Namespace::Default
+        klass.should_receive(:new).with(hash_including(name: DEFAULT_NAMESPACE))
+        initialize_site
+      end
+
+      context 'with option :external false' do
+        let(:converter) { Wikilink::Converter::Site.new name: name, external: false }
+        it 'leaves option :external as false' do
+          converter.options[:external].should be_false
+        end
+      end
+      context 'with option :prefix "/wiki/"' do
+        let(:converter) { Wikilink::Converter::Site.new name: name, prefix: '/wiki/' }
+        it 'leaves option :prefix as "/wiki/"' do
+          converter.options[:prefix].should eq('/wiki/')
+        end
+      end
+    end
+
+    describe '#run' do
+      it 'delegates default namespace to Namespace::Default instance' do
+        ->{ converter.run(':', DEFAULT_NAMESPACE, 'Home', 'Name', '/') }.
+          should forward(:run).to(default_namespace).with(':', 'Home', 'Name', '/')
+      end
+
+      context 'with method #on_namespace_topics defined' do
+        before { Wikilink::Converter::Namespace::Default.unstub(:new) }
+        class SpecSite < Wikilink::Converter::Site
+          def on_namespace_topics(colon, path, name, current_page)
+            'it works'
+          end
+        end
+        let(:converter) { SpecSite.new }
+        it 'invokes #on_namespace_topics to handle namespace topics' do
+          converter.run(':', 'topics', 'Home', 'Name', '/').should eq('it works')
+        end
+
+        context 'but user has override it' do
+          before {
+            converter.namespace('topics') do
+              'use this version'
+            end
+          }
+
+          it 'uses user version' do
+            converter.run(':', 'topics', 'Home', 'Name', '/').should eq('use this version')
+          end
+        end
+      end
+
+      context 'with method #on_namespace_ defined' do
+        before { Wikilink::Converter::Namespace::Default.unstub(:new) }
+        class SpecSite < Wikilink::Converter::Site
+          def on_namespace_(colon, path, name, current_page)
+            'it works'
+          end
+        end
+        let(:converter) { SpecSite.new }
+        it 'invokes #on_namespace_ to handle default namespace' do
+          converter.run(':', DEFAULT_NAMESPACE, 'Home', 'Name', '/').should eq('it works')
+        end
+
+        context 'but user has override it' do
+          before {
+            converter.namespace do
+              'use this version'
+            end
+          }
+
+          it 'uses user version' do
+            converter.run(':', DEFAULT_NAMESPACE, 'Home', 'Name', '/').should eq('use this version')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/wikilink/converter/sites/ruby_china_spec.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+require File.expand_path('../../../../spec_helper', __FILE__)
+require 'wikilink/converter/sites/ruby_china'
+
+describe Wikilink::Converter::Sites::RubyChina do
+  subject { converter.method(:run) }
+
+  context 'ruby-china.org' do
+    let(:rubychina) { Wikilink::Converter::Sites::RubyChina }
+    let(:converter) {
+      Wikilink::Converter.new { |on| on.current_site(rubychina) }
+    }
+
+    it { should convert('[[Ruby]]').to('<a href="/wiki/Ruby">Ruby</a>') }
+    it { should convert('[[topic:1]]').to('<a href="/topics/1">topic:1</a>') }
+    it { should convert('[[node:1]]').to('<a href="/topics/node1">node:1</a>') }
+  end
+
+  context 'external ruby-taiwan.org' do
+    let(:rubytaiwan) { Wikilink::Converter::Sites::RubyTaiwan }
+    let(:converter) {
+      Wikilink::Converter.new { |on|
+        on.site('rubytaiwan', rubytaiwan)
+      }
+    }
+
+    it { should convert('[[rubytaiwan:Ruby]]').to('<a class="external" href="http://ruby-taiwan.org/wiki/Ruby">rubytaiwan:Ruby</a>') }
+    it { should convert('[[rubytaiwan:topic:1]]').to('<a class="external" href="http://ruby-taiwan.org/topics/1">rubytaiwan:topic:1</a>') }
+    it { should convert('[[rubytaiwan:node:1]]').to('<a class="external" href="http://ruby-taiwan.org/topics/node1">rubytaiwan:node:1</a>') }
+  end
+end

data/spec/wikilink/converter/sites/wikipedia_spec.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+require File.expand_path('../../../../spec_helper', __FILE__)
+require 'wikilink/converter/sites/wikipedia'
+
+describe Wikilink::Converter::Sites::Wikipedia do
+  subject { converter.method(:run) }
+
+  context 'en current site' do
+    let(:wikipedia) { Wikilink::Converter::Sites::Wikipedia }
+    let(:converter) {
+      Wikilink::Converter.new { |on| on.current_site(wikipedia) }
+    }
+    it { should convert('[[Ruby]]').to('<a href="/wiki/Ruby">Ruby</a>')}
+  end
+
+  context 'zh external site' do
+    let(:wikipedia) { Wikilink::Converter::Sites::Wikipedia }
+    let(:converter) {
+      Wikilink::Converter.new(lang: 'zh') do |on|
+        on.site('wiki', wikipedia)
+      end
+    }
+    it { should convert('[[wiki:红宝石]]').to('<a class="external" href="http://zh.wikipedia.org/wiki/红宝石">wiki:红宝石</a>')}
+  end
+end