wikilink-converter 0.1.0

data/spec/wikilink/converter_spec.rb

@@ -0,0 +1,177 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Wikilink::Converter do
+  CURRENT_SITE = Wikilink::Converter::CURRENT_SITE
+
+  let(:converter) { Wikilink::Converter.new }
+
+  describe '#run' do
+    subject { converter.method(:run) }
+    it 'does nothing when text does not contain wikilink' do
+      subject.should convert("Hello World").to('Hello World')
+    end
+    it 'converts wikilink to element A' do
+      subject.should convert('[[Home]]').to('<a href="/Home">Home</a>')
+    end
+    it 'converts multiple wikilinks to elements A' do
+      subject.should convert('[[Home]] [[Page]]').
+        to('<a href="/Home">Home</a> <a href="/Page">Page</a>')
+    end
+    it 'converts escaped \\[[wikilink]] to [[wikilink]]' do
+      subject.should convert('\\[[Hello]] World').to('[[Hello]] World')
+    end
+    it 'ignores [[ and ]] in different lines' do
+      subject.should convert("[[Hel\nlo]]").to("[[Hel\nlo]]")
+    end
+    it 'ignores wikilink with last character is :' do
+      subject.should convert("[[:digit:]]").to("[[:digit:]]")
+    end
+    it 'ignores wikilink with last character is :' do
+      subject.should convert("[[:digit:]]").to("[[:digit:]]")
+    end
+    it 'ignores wikilink which path starts with [' do
+      subject.should convert("[[[test]]").to("[[[test]]")
+    end
+    it 'ignores wikilink which path starts with ]' do
+      subject.should convert("[[]test]]").to("[[]test]]")
+    end
+
+    context 'in namespace topics' do
+      context 'with default handler' do
+        before do
+          converter.on('topics', Wikilink::Converter::Namespace::Default)
+        end
+        it { should convert('[[topics:World]]').to('<a href="/World">topics:World</a>') }
+      end
+    end
+
+    context 'with site wiki' do
+      let(:wiki) { double(:wiki) }
+      before { converter.site('wiki', wiki) }
+      subject { converter.method(:run) }
+
+      it 'use link to external wiki' do
+        wiki.should_receive(:run).with(any_args).and_return('<a>works</a>')
+        subject.should convert('[[wiki:Ruby]]').to('<a>works</a>')
+      end
+    end
+
+    describe 'pipe trick' do
+      it { should convert('[[Hello|]]').to('<a href="/Hello">Hello</a>') }
+      it { should convert('[[Hello/World|]]').to('<a href="/Hello/World">World</a>') }
+
+      context 'in namespace topics' do
+        context 'with default handler' do
+          before do
+            converter.on('topics', Wikilink::Converter::Namespace::Default)
+          end
+          it { should convert('[[topics:World|]]').to('<a href="/World">World</a>') }
+          it { should convert('[[:topics:World|]]').to('<a href="/World">World</a>') }
+        end
+      end
+    end
+  end
+
+  describe '#on_default_site' do
+    it 'is a shortcut of #on_site' do
+      converter.should_receive(:on_site).with(CURRENT_SITE, 'arg')
+      converter.on_current_site 'arg'
+    end
+  end
+
+  describe '#on_site' do
+    let(:default_site) { double(:default_site).as_null_object }
+    let(:site) { double(:site).as_null_object }
+    before { Wikilink::Converter::Site.stub(:new) { default_site } }
+    let(:converter) { Wikilink::Converter.new }
+    
+    context 'without any arguments' do
+      it 'does not create new instance' do
+        converter # call it to initialize first
+        Wikilink::Converter::Site.should_not_receive :new
+        converter.on_site
+      end
+      it 'yields the default site converter' do
+        converter.on_site do |site_converter|
+          site_converter.should eq(default_site)
+        end
+      end
+    end
+
+    context 'with site name' do
+      it 'creates a new instance of Wikilink::Converter::Site as the site converter' do
+        converter # call it to initialize first
+        Wikilink::Converter::Site.should_receive(:new).once
+        converter.on_site 'wikipedia'
+      end
+      it 'initializes the instance with option :name' do
+        converter # call it to initialize first
+        Wikilink::Converter::Site.should_receive(:new).with(hash_including(name: 'wikipedia')).once
+        converter.on_site 'wikipedia'
+      end
+      it 'yields the new converter instance' do
+        converter # call it to initialize first
+        Wikilink::Converter::Site.should_receive(:new).once.and_return(site)
+        converter.on_site('wikipedia') do |site_converter|
+          site_converter.should eq(site)
+        end
+      end
+      context 'and options' do
+        let(:options) { { foo: :bar } }
+        it 'initializes the instance with given options' do
+          converter # call it to initialize first
+          Wikilink::Converter::Site.should_receive(:new).with(hash_including(foo: :bar)).once
+          converter.on_site 'wikipedia', options
+        end
+      end
+    end
+
+    context 'with object' do
+      it 'does not create new instance' do
+        converter # call it to initialize first
+        Wikilink::Converter::Site.should_not_receive :new
+        converter.on_site site
+      end
+      it 'yields the object' do
+        converter.on_site(site) do |site_converter|
+          site_converter.should eq(site)
+        end
+      end
+    end
+  end
+
+  describe '#execute' do
+    subject { converter.method(:execute) }
+
+    it 'does nothing without any registered action handlers' do
+      subject.should convert('{{toc}}').to('{{toc}}')
+    end
+    it 'converts escaped \\{{magicwords}} to {{magicwords}}' do
+      subject.should convert('\\{{toc}}').to('{{toc}}')
+    end
+
+    context 'with handler registered on action toc' do
+      before {
+        converter.on_action('toc') do |arg|
+          "Table of Contents#{arg}"
+        end
+      }
+
+      it 'uses the handler to process {{toc}}' do
+        subject.should convert('{{toc}}').to('Table of Contents')
+      end
+      it 'passes content after colon as argument to handler' do
+        subject.should convert('{{toc: rocks}}').to('Table of Contents rocks')
+      end
+      it 'ignores {{ and }} in different lines' do
+        subject.should convert("{{toc:\nrocks}}").to("{{toc:\nrocks}}")
+      end
+      it 'ignores magicwords which last character is colon' do
+        subject.should convert("{{toc:}}").to("{{toc:}}")
+      end
+      it 'ignores other unregistered actions' do
+        subject.should convert("{{delete:all:site}}").to("{{delete:all:site}}")
+      end
+    end
+  end
+end

data/wikilink-converter.gemspec

@@ -0,0 +1,98 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wikilink-converter}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Ian Yang}]
+  s.date = %q{2011-12-04}
+  s.description = %q{convert [[WikiLink]] to <a>}
+  s.email = %q{me@iany.me}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/wikilink-converter.rb",
+    "lib/wikilink/converter.rb",
+    "lib/wikilink/converter/namespace.rb",
+    "lib/wikilink/converter/site.rb",
+    "lib/wikilink/converter/sites/ruby_china.rb",
+    "lib/wikilink/converter/sites/wikipedia.rb",
+    "lib/wikilink/converter/utils.rb",
+    "spec/spec_helper.rb",
+    "spec/support/matchers.rb",
+    "spec/wikilink/converter/namespace_spec.rb",
+    "spec/wikilink/converter/site_spec.rb",
+    "spec/wikilink/converter/sites/ruby_china_spec.rb",
+    "spec/wikilink/converter/sites/wikipedia_spec.rb",
+    "spec/wikilink/converter_spec.rb",
+    "wikilink-converter.gemspec"
+  ]
+  s.homepage = %q{http://github.com/doitian/wikilink-converter}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{convert [[WikiLink]] to <a>}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_development_dependency(%q<guard-yard>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<rb-inotify>, [">= 0"])
+      s.add_development_dependency(%q<libnotify>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_dependency(%q<guard-yard>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<rb-inotify>, [">= 0"])
+      s.add_dependency(%q<libnotify>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<guard-bundler>, [">= 0"])
+    s.add_dependency(%q<guard-yard>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<rb-inotify>, [">= 0"])
+    s.add_dependency(%q<libnotify>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: wikilink-converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ian Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &16725440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16725440
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &16724920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16724920
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &16724440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16724440
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &16723920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16723920
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &16723420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16723420
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &16722940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16722940
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &16722440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16722440
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &16721920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16721920
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: &16721420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16721420
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &16720940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16720940
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &16720420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16720420
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: &16719920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16719920
+description: convert [[WikiLink]] to <a>
+email: me@iany.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/wikilink-converter.rb
+- lib/wikilink/converter.rb
+- lib/wikilink/converter/namespace.rb
+- lib/wikilink/converter/site.rb
+- lib/wikilink/converter/sites/ruby_china.rb
+- lib/wikilink/converter/sites/wikipedia.rb
+- lib/wikilink/converter/utils.rb
+- spec/spec_helper.rb
+- spec/support/matchers.rb
+- spec/wikilink/converter/namespace_spec.rb
+- spec/wikilink/converter/site_spec.rb
+- spec/wikilink/converter/sites/ruby_china_spec.rb
+- spec/wikilink/converter/sites/wikipedia_spec.rb
+- spec/wikilink/converter_spec.rb
+- wikilink-converter.gemspec
+homepage: http://github.com/doitian/wikilink-converter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3886316938632370921
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: convert [[WikiLink]] to <a>
+test_files: []