piki_doc 0.0.2.2

data/Changelog

@@ -0,0 +1,12 @@
+== 0.0.2.2 / 2011-01-18
+
+* fix some HTML output bugs, thanx mayuco.
+
+== 0.0.2.1 / 2009-04-30
+
+* fake version up to genarate gem on GitHub.
+
+== 0.0.1 / 2009-04-20
+
+* initial release
+

data/README.ja.hiki

@@ -0,0 +1,71 @@
+! PikiDocについて
+
+!! はじめに
+
+[[HikiDoc|http://hikidoc.rubyforge.org/svn/trunk/README.ja]]を拡張し、
+HikiDocの機能の一つである「プラグイン」機能を簡単にを追加できるようにした
+ライブラリです。
+
+本家HikiDocライブラリもバンドルしているため、このライブラリを入れるだけで
+使えます。
+
+!! 使い方
+
+プラグインを追加する部分以外は、本家の機能がそのまま使えます。
+
+ require 'piki_doc'
+ PikiDoc.to_xhtml(<<-EOS
+ ! PikiDocについて
+ 
+ !! はじめに
+ EOS
+
+!!! プラグインの使い方
+
+あらかじめPikiDoc.register()にプラグインを指定してください。今のところ、Gist
+プラグインとASINプラグインがバンドルされています。
+
+ PikiDoc.register(PikiDoc::Bundles::Gist.new, PikiDoc::Bundles::Asin.new)
+ PikiDoc.to_xhtml(<<-HTML)
+ !!!! ASIN
+
+ インライン {{asin('4797336625', 'morodiary05-22')}}
+
+ {{asin('4797336625', 'morodiary05-22')}}
+
+ !!!! Gist
+
+ インライン {{gist('88086')}}
+
+ {{gist('88086')}}
+ HTML
+
+次のように出力されます
+
+!!!! ASIN
+
+インライン {{asin('4797336625', 'morodiary05-22')}}
+
+{{asin('4797336625', 'morodiary05-22')}}
+
+!!!! Gist
+
+インライン {{gist(88086)}}
+
+{{gist(88086)}}
+
+!! プラグインの自作方法
+
+lib/piki_doc/bundles/内のサンプルと、features/*内の外部仕様を参考にしてください。
+
+!! Thanks
+
+!!! HikiDoc authors
+
+- 2005, Kazuhiko <kazuhiko@fdiary.net>
+- 2007, Minero Aoki
+
+!! ライセンス
+
+HikiDoc本家と同じ修正BSDライセンスです。
+

data/Rakefile

@@ -0,0 +1,98 @@
+$: << "./lib"
+require 'rubygems'
+require 'piki_doc'
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+NAME              = ENV["GEMNAME"] || "piki_doc"
+HOMEPAGE          = "http://github.com/moro/#{NAME}/"
+AUTHOR            = "MOROHASHI Kyosuke"
+EMAIL             = "moronatural@gmail.com"
+DESCRIPTION       = "extended HikiDoc to able to plug plugins."
+VERS              = PikiDoc::Version
+
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = [
+  '--title', "#{NAME} documentation",
+  "--charset", "utf-8",
+  "--opname", "index.html",
+  "--line-numbers",
+  "--main", "README.ja.hiki",
+  "--inline-source",
+]
+
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = "-w"
+  t.rspec_opts = %w[--format progress --color]
+end
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format progress"
+end
+
+gemspec = Gem::Specification.new do |s|
+  s.name              = NAME
+  s.version           = VERS
+  s.platform          = Gem::Platform::RUBY
+  s.has_rdoc          = false
+  s.extra_rdoc_files  = ["README.ja.hiki", "Changelog"]
+  s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+  s.summary           = DESCRIPTION
+  s.description       = DESCRIPTION
+  s.author            = AUTHOR
+  s.email             = EMAIL
+  s.homepage          = HOMEPAGE
+  s.executables       = []
+  s.require_path      = "lib"
+  s.test_files        = Dir["spec/**/*_spec.rb"] + Dir["features/**/*.rb"] + Dir["features/*.feature"]
+
+  s.files = %w(README.ja.hiki Changelog Rakefile) +
+    Dir.glob("{bin,doc,lib,templates,generators,extras,website,script}/**/*") + 
+    Dir.glob("ext/**/*.{h,c,rb}") +
+    Dir.glob("examples/**/*.rb") +
+    Dir.glob("tools/*.rb") +
+    Dir.glob("rails/*.rb")
+
+  s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(gemspec) do |p|
+  p.need_tar = true
+  p.gem_spec = gemspec
+end
+
+task :install do
+  name = "#{NAME}-#{VERS}.gem"
+  sh %{rake package}
+  sh %{gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+  sh %{gem uninstall #{NAME}}
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts gemspec.to_ruby
+end
+
+desc 'Update gem spec'
+task :gemspec do
+  open("#{NAME}.gemspec", 'w').write gemspec.to_ruby
+end
+
+desc "output example from README.ja.hiki"
+task "readme_example" do
+  require 'piki_doc'
+  require 'piki_doc/bundles/gist'
+  require 'piki_doc/bundles/asin'
+
+  PikiDoc.register(PikiDoc::Bundles::Gist.new, PikiDoc::Bundles::Asin.new)
+  puts PikiDoc.to_xhtml(File.read("README.ja.hiki"))
+end
+

data/features/asin_plugin.feature

@@ -0,0 +1,25 @@
+# language: ja
+フィーチャ: Asinプラグインを試す
+  プラグイン作者として
+  Asinプラグインがちゃんと動いていることを確認したい
+
+  背景:
+  前提    "Asin"プラグインを登録する
+
+  シナリオ: ブロックプラグイン
+  もし   以下のHiki記法テキストをXHTMLにする
+    """
+! ASIN Railsレシピブック
+{{asin('4797336625', 'morodiary05-22')}}
+    """
+  # かつ   結果を目視
+  ならば "div.plugin.asin > iframe"要素が含まれること
+
+  シナリオ: インラインプラグイン
+  もし   以下のHiki記法テキストをXHTMLにする
+    """
+Railsレシピブック {{asin('4797336625', 'morodiary05-22')}}を書きました。
+    """
+  # かつ   結果を目視
+  ならば "span.plugin.asin > a[href='http://www.amazon.co.jp/exec/obidos/ASIN/4797336625/morodiary05-22/ref=nosim']"要素が含まれること
+

data/features/gist_plugin.feature

@@ -0,0 +1,28 @@
+# language: ja
+フィーチャ: Gistプラグインを試す
+  プラグイン作者として
+  Gistプラグインがちゃんと動いていることを確認したい
+
+  背景:
+  前提   "Gist"プラグインを登録する
+
+  シナリオ: ブロックプラグイン
+  もし   以下のHiki記法テキストをXHTMLにする
+    """
+! Gist
+{{gist(123456)}}
+    """
+  # かつ   結果を目視
+  ならば "div.plugin.gist > script[src='http://gist.github.com/123456.js']"要素が含まれること
+  かつ   "h1"要素のテキストは"Gist"であること
+
+  シナリオ: インラインプラグイン
+  もし   以下のHiki記法テキストをXHTMLにする
+    """
+! Gist
+こちらをご覧ください。{{gist(123456)}}
+    """
+  # かつ   結果を目視
+  ならば "a[href='http://gist.github.com/123456']"要素が含まれること
+  かつ   "h1"要素のテキストは"Gist"であること
+

data/features/step_definitions/pluggable_hikidoc_steps.rb

@@ -0,0 +1,28 @@
+#coding:utf-8
+require 'piki_doc'
+require 'piki_doc/bundles/gist'
+require 'piki_doc/bundles/asin'
+require 'nokogiri'
+
+When /^"([^\"]*)"プラグインを登録する$/ do |name|
+  PikiDoc.register(PikiDoc::Bundles.const_get(name).new)
+end
+
+When /^以下のHiki記法テキストをXHTMLにする$/ do |text|
+  @out = PikiDoc.to_xhtml(text)
+end
+
+Then /^"([^\"]*)"要素が含まれること$/ do |selector|
+  @doc ||= Nokogiri::HTML(@out)
+  @doc.css(selector).should_not be_empty
+end
+
+When /^"([^\"]*)"要素のテキストは"([^\"]*)"であること$/ do |selector, text|
+  @doc ||= Nokogiri::HTML(@out)
+  @doc.css(selector).text.should == text
+end
+
+When /^結果を目視$/ do
+  at_exit{ ["-" * 80, @out, "-" * 80].each{|s| puts s } }
+end
+

data/features/support/env.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+$KCODE = "u" if RUBY_VERSION < "1.9"
+
+$LOAD_PATH << File.expand_path("../../lib", File.dirname(__FILE__))
+

data/lib/piki_doc.rb

@@ -0,0 +1,11 @@
+
+module PikiDoc
+  Version = "0.0.2.2"
+
+  autoload "Document", "piki_doc/document"
+  def register(*plugins); PikiDoc::Document.register(*plugins); end
+  def to_html(src, options={}); PikiDoc::Document.to_html(src, options) ; end
+  def to_xhtml(src, options={}); PikiDoc::Document.to_xhtml(src, options) ; end
+  module_function :register, :to_html, :to_xhtml
+end
+

data/lib/piki_doc/bundles/asin.rb

@@ -0,0 +1,25 @@
+module PikiDoc
+  module Bundles
+    class Asin
+      include PluginAdapter
+      def initialize(host = "www.amazon.co.jp", iframe_host = "rcm-jp.amazon.co.jp")
+        @host = host
+        @iframe_host = iframe_host
+      end
+
+      def inline_plugin(src)
+        (asin, id), = src.scan(/\(\s*'(\d+)',\s*'([a-z0-9\-]+)'\s*\)/)
+        plugin_dom("span", <<-HTML)
+<a href="http://#{@host}/exec/obidos/ASIN/#{asin}/#{id}/ref=nosim">Amazon</a>
+HTML
+      end
+      def block_plugin(src)
+        (asin, id), = src.scan(/\(\s*'(\d+)',\s*'([a-z0-9\-]+)'\s*\)/)
+        plugin_dom("div", <<-HTML)
+<iframe src="http://#{@iframe_host}/e/cm?t=#{id}&o=9&p=8&l=as1&asins=#{asin}&fc1=000000&IS2=1&lt1=_blank&m=amazon&lc1=0000FF&bc1=000000&bg1=FFFFFF&f=ifr&nou=1"
+        style="width:120px;height:240px;" scrolling="no" marginwidth="0" marginheight="0" frameborder="0"></iframe>
+HTML
+      end
+    end
+  end
+end

data/lib/piki_doc/bundles/gist.rb

@@ -0,0 +1,19 @@
+require 'piki_doc/bundles/plugin_adapter'
+
+module PikiDoc
+  module Bundles
+    class Gist
+      include PluginAdapter
+      def inline_plugin(src)
+        (id,), = src.scan(/gist\((\d+)\)/)
+        %Q[<a href="http://gist.github.com/#{id}">Gist:#{id}</a>]
+      end
+
+      private
+      def plugin(src)
+        (id,), = src.scan(/gist\((\d+)\)/)
+        %Q[<script src="http://gist.github.com/#{id}.js"></script>]
+      end
+    end
+  end
+end

data/lib/piki_doc/bundles/plugin_adapter.rb

@@ -0,0 +1,34 @@
+module PikiDoc
+  module Bundles
+    module PluginAdapter
+      RE = /\A([a-z]+)\(.[^\)]+\)/
+      def accept?(src)
+        (name,_), = src.scan(RE)
+        name == plugin_name
+      end
+
+      def inline_plugin(src)
+        plugin_dom("span", plugin(src))
+      end
+
+      def block_plugin(src)
+        plugin_dom("div", plugin(src))
+      end
+
+      private
+      def plugin(src); raise NotImplementedError; end
+
+      def plugin_name
+        self.class.name.split("::").last.
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          downcase
+      end
+
+      def plugin_dom(tag, content)
+        %Q[<#{tag} class='plugin #{plugin_name}'>#{content}</#{tag}>]
+      end
+    end
+  end
+end
+

data/lib/piki_doc/document.rb

@@ -0,0 +1,32 @@
+require 'uri'
+require 'piki_doc/output'
+require 'piki_doc/image_uri_autolink_fix'
+require 'vendor/hikidoc'
+
+module PikiDoc
+  class Document < ::HikiDoc
+    @@plugins ||= []
+    include ImageUriAutolinkFix
+
+    class << self
+      def plugins; @@plugins; end
+      def register(*plugins)
+        @@plugins.concat(plugins)
+      end
+
+      def lint(plugin)
+        [:inline_plugin, :block_plugin].any?{|m| plugin.respond_to?(m) } && \
+        plugin.respond_to?(:accept?)
+      end
+
+      def to_xhtml(src, options = {})
+        new(::PikiDoc::HTMLOutput.new(" />", @@plugins), options).compile(src)
+      end
+
+      def to_html(src, options = {})
+        new(::PikiDoc::HTMLOutput.new(">", @@plugins), options).compile(src)
+      end
+    end
+  end
+end
+

data/lib/piki_doc/image_uri_autolink_fix.rb

@@ -0,0 +1,12 @@
+module PikiDoc
+  module ImageUriAutolinkFix
+    private
+    def compile_uri_autolink(uri)
+      if(image?(path = URI(uri).path))
+        @output.image_hyperlink(uri, path.split(/\//).last)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/piki_doc/output.rb

@@ -0,0 +1,27 @@
+require 'vendor/hikidoc'
+
+module PikiDoc
+  class HTMLOutput < ::HikiDoc::HTMLOutput
+    def initialize(suffix, plugins)
+      super(suffix)
+      @inlines = plugins.select{|p| p.respond_to?(:inline_plugin) }
+      @blocks = plugins.select{|p| p.respond_to?(:block_plugin) }
+    end
+
+    def inline_plugin(src)
+      if plugin = @inlines.detect{|p| p.accept?(src) }
+        plugin.inline_plugin(src)
+      else
+        super
+      end
+    end
+
+    def block_plugin(src)
+      if plugin = @blocks.detect{|p| p.accept?(src) }
+        @f.puts plugin.block_plugin(src)
+      else
+        super
+      end
+    end
+  end
+end