html-pipeline-wiki-link 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# CHANGELOG
+
+## 0.0.1 - *Initial Version*
+
+* Built support for basic wiki links and wiki links with descriptions.
+* Built the basic gem infrastructure.

data/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Adding new features
+
+This section includes advice on how to build new features for the project & what kind of process it includes. 
+
+* This is how we like people to add new features:
+    * Add only one feature at a time each on a new branch
+* Here are some specifics on the coding style we prefer:
+    * Write the code test first
+    * Document the code whether or not it is part of the public API
+        * We use [YARD documentation](http://yardoc.org/)
+        * Documentation comments are in [Markdown](http://daringfireball.net/projects/markdown/) format
+* This is how you send your pull request:
+    * TBD
+* You should include the following tests:
+    * Unit tests (including tests for failure cases and testing exception paths) at a bare minimum
+    * If creating a new chunk of code (rather than changing already existing code) include integration tests as well
+* These are the updates we hope you make to the changelog:
+    * Create a header underneath the current version number with a brief description of the feature
+    * Document any new command-line options
+
+Don’t get discouraged! We estimate that the response time from the maintainers is around: One week, perhaps longer in December.
+
+# Bug triage
+
+This section explains how bug triaging is done for your project. Help beginners by including examples to good bug reports and providing them questions they should look to answer. 
+
+* You can help report bugs by filing them here: [New Issue](https://github.com/lifted-studios/html-pipeline-wiki-link/issues/new)
+* You can look through the existing bugs here: [Issues List](https://github.com/lifted-studios/html-pipeline-wiki-link/issues)
+
+* Look at existing bugs and help us understand if
+    * The bug is reproducible? Is it reproducible in other environments (browsers)? What are the steps to reproduce? 
+
+* You can close fixed bugs by testing old tickets to see if they are happening
+* You can update our change log here
+* You can remove duplicate bug reports
+
+# Translations
+
+This section includes any instructions or translation needs your project has. 
+
+* You can help us translate our project here: 
+
+# Documentation
+
+This section includes any help you need with the documentation and where it can be found. Code needs explanation, and sometimes those who know the code well have trouble explaining it to someone just getting into it. 
+
+* Help us with documentation here
+
+# Community 
+This section includes ideas on how non-developers can help with the project. Here's a few examples:
+
+* You can help us answer questions our users have here: 
+* You can help build and design our website here:
+* You can help write blog posts about the project by: 
+* You can help with newsletters and internal communications by: 
+
+* Create an example of the project in real world by building something or
+showing what others have built. 
+* Write about other people’s projects based on this project. Show how
+it’s used in daily life. Take screenshots and make videos!
+
+
+# Your first bugfix
+This section should help a person get started with their very first bug fix and thinking through the problem.
+
+* If you have further questions, contact:
+
+This contributing file template is from [contribute.md](http://contribute.md/).

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    html-pipeline-wiki-link (0.0.1)
+      html-pipeline (>= 0.0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    escape_utils (0.3.1)
+    gemoji (1.4.0)
+    github-markdown (0.5.3)
+    html-pipeline (0.0.8)
+      activesupport (>= 2)
+      escape_utils (~> 0.2)
+      gemoji (~> 1.0)
+      github-markdown (~> 0.5)
+      nokogiri (~> 1.4)
+      rinku (~> 1.7)
+      sanitize (~> 2.0)
+    i18n (0.6.4)
+    minitest (3.5.0)
+    multi_json (1.6.1)
+    nokogiri (1.5.6)
+    rake (10.0.2)
+    redcarpet (2.1.1)
+    rinku (1.7.2)
+    sanitize (2.0.3)
+      nokogiri (>= 1.4.4, < 1.6)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  html-pipeline-wiki-link!
+  minitest (~> 3.0)
+  rake (~> 10.0)
+  redcarpet
+  yard (~> 0.8)

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2013 Lee Dohm, Lifted Studios
+
+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.md

@@ -0,0 +1,74 @@
+[![Build Status](https://travis-ci.org/lifted-studios/html-pipeline-cite.png?branch=master)](https://travis-ci.org/lifted-studios/html-pipeline-cite)
+
+# HTML::Pipeline WikiLink Gem
+
+An HTML::Pipeline filter for handling WikiMedia-style wiki links.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline-wiki-link'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install html-pipeline-wiki-link
+```
+
+## Usage
+
+This library is designed as an extension of the [HTML::Pipeline]() system for creating pipelines of text conversions.  It can work on its own or in conjunction with other filters descended from `HTML::Pipeline::Filter`.
+
+To use this filter on its own:
+
+```ruby
+require 'html/pipeline/wiki_link'
+
+filter = HTML::Pipeline::WikiLinkFilter.new('Some text with a [[Link]] in it.')
+filter.call
+```
+
+Filters can be combined into a pipeline which causes each filter to hand its output to the next filter's input.  For example, you could support wiki links in markdown by creating a pipeline like this:
+
+```ruby
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::MarkdownFilter,
+  HTML::Pipeline::WikiLinkFilter
+]
+
+result = pipeline.call <<-CODE
+This is some **Markdown** with a [[Link]] in it!
+CODE
+```
+
+## Troubleshooting
+
+## Development
+
+To see what has changed in recent versions of Lifted Wiki, see the [CHANGELOG](https://github.com/lifted-studios/html-pipeline-wiki-link/blob/master/CHANGELOG.md).
+
+## Core Team Members
+
+* [Lee Dohm](https://github.com/lee-dohm/)
+
+## Resources
+
+<!-- ### Other questions
+
+Feel free to chat with the Lifted Wiki core team (and many other users) on IRC in the  [#project](irc://irc.freenode.net/project) channel on Freenode, or via email on the [Project mailing list]().
+ -->
+
+## Copyright
+
+Copyright © 2013 Lee Dohm, Lifted Studios. See [LICENSE](https://github.com/lifted-studios/html-pipeline-wiki-link/blob/master/LICENSE.md) for details.
+
+Project is a member of the [OSS Manifesto](http://ossmanifesto.com/).

data/Rakefile

@@ -0,0 +1,66 @@
+# 
+# Copyright (c) 2013 by Lifted Studios.  All Rights Reserved.
+# 
+
+require 'bundler/gem_tasks'
+require 'html/pipeline/wiki_link/version'
+require 'rake/clean'
+require 'rake/testtask'
+require 'yard'
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  HTML::Pipeline::WikiLink::VERSION
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+CLEAN.include('.yardoc')
+CLOBBER.include('doc', 'pkg')
+
+task :default => [:test, :yard]
+
+desc "Execute all tests"
+task :test => [:spec]
+
+Rake::TestTask.new('spec') do |spec|
+  spec.libs << 'spec'
+  spec.test_files = Dir['spec/**/*_spec.rb']
+  # spec.warning = true
+end
+
+YARD::Rake::YardocTask.new
+
+desc 'Build gem'
+task :build do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc 'Create a release build'
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git pull"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :install => :build do
+  sh "gem install pkg/#{gem_file}"
+end

data/html-pipeline-wiki-link.gemspec

@@ -0,0 +1,42 @@
+# 
+# Copyright (c) 2012-2013 by Lifted Studios.  All Rights Reserved.
+# 
+
+require 'date'
+require File.expand_path('../lib/html/pipeline/wiki_link/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.name    = 'html-pipeline-wiki-link'
+  s.version = HTML::Pipeline::WikiLink::VERSION
+  s.date    = Date.today.to_s
+
+  s.summary     = "A personal wiki solution"
+  s.description = "A personal wiki solution inspired by Gollum"
+
+  s.authors  = ["Lee Dohm"]
+  s.email    = 'lee@liftedstudios.com'
+  s.homepage = 'https://github.com/lifted-studios/html-pipeline-wiki-link'
+  s.license  = 'MIT'
+
+  s.require_paths = ['lib']
+
+  s.add_dependency('html-pipeline', '>= 0.0.8')
+
+  s.add_development_dependency('minitest', '~> 3.0')
+  s.add_development_dependency('rake', '~> 10.0')
+  s.add_development_dependency('redcarpet')
+  s.add_development_dependency('yard', '~> 0.8')
+
+  s.files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }
+
+  s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+end

data/lib/html/pipeline/wiki_link.rb

@@ -0,0 +1,6 @@
+#
+# Copyright (c) 2013 by Lifted Studios.  All Rights Reserved.
+#
+
+require 'html/pipeline/wiki_link/version.rb'
+require 'html/pipeline/wiki_link/wiki_link_filter.rb'

data/lib/html/pipeline/wiki_link/version.rb

@@ -0,0 +1,12 @@
+# 
+# Copyright (c) 2012-2013 by Lifted Studios.  All Rights Reserved.
+# 
+
+module HTML
+  class Pipeline
+    module WikiLink
+      # Version number for the Lifted Wiki gem.
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/html/pipeline/wiki_link/wiki_link_filter.rb

@@ -0,0 +1,20 @@
+# 
+# Copyright (c) 2012-2013 by Lifted Studios.  All Rights Reserved.
+# 
+
+require 'html/pipeline'
+
+module HTML
+  class Pipeline
+    # An `HTML::Pipeline` filter class that detects wiki-style links and converts them to HTML links.
+    class WikiLinkFilter < Filter
+      # Performs the translation and returns the updated text.
+      # 
+      # @return [String] Updated text with translated wiki links.
+      def call
+        text = html.gsub(/\[\[(.*)\|(.*)\]\]/, '<a href="/\1">\2</a>')
+        text.gsub(/\[\[(.*)\]\]/, '<a href="/\1">\1</a>')
+      end
+    end
+  end
+end

data/spec/wiki_link_filter_spec.rb

@@ -0,0 +1,43 @@
+# 
+# Copyright (c) 2012-2013 by Lifted Studios.  All Rights Reserved.
+# 
+
+gem 'minitest'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'html/pipeline/wiki_link'
+require 'nokogiri'
+
+describe HTML::Pipeline::WikiLinkFilter do
+  # Creates a new `WikiLinkFilter` object.
+  # 
+  # @param text Text for the filter to parse.
+  # @return [HTML::Pipeline::WikiLinkFilter] Newly created filter object.
+  def new_filter(text)
+    HTML::Pipeline::WikiLinkFilter.new(text)
+  end
+
+  it 'can be instantiated' do
+    filter = new_filter('Just some sample text')
+
+    filter.wont_be_nil
+  end
+
+  it 'converts a normal wiki link' do
+    filter = new_filter('[[Link]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Link">Link</a>'
+  end
+
+  it 'converts a wiki link with a description' do
+    filter = new_filter('[[Link|Description]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Link">Description</a>'
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-wiki-link
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lee Dohm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A personal wiki solution inspired by Gollum
+email: lee@liftedstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- html-pipeline-wiki-link.gemspec
+- lib/html/pipeline/wiki_link.rb
+- lib/html/pipeline/wiki_link/version.rb
+- lib/html/pipeline/wiki_link/wiki_link_filter.rb
+- spec/wiki_link_filter_spec.rb
+homepage: https://github.com/lifted-studios/html-pipeline-wiki-link
+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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 2
+summary: A personal wiki solution
+test_files:
+- spec/wiki_link_filter_spec.rb
+has_rdoc: