juli 2.0.0

data/lib/juli/macro/amazon.rb

@@ -0,0 +1,33 @@
+require 'juli/macro/template_base'
+
+module Juli
+  module Macro
+    # generate Amazon link
+    #
+    # Amazon link template can be defined at 'amazon' entry in
+    # JULI_REPO/.juli/config.
+    #
+    # if it is not defined, then default template here is used.
+    class Amazon < TemplateBase
+      DEFAULT_TEMPLATE = <<-EOS
+        <iframe src="http://rcm-jp.amazon.co.jp/e/cm?t=wells00-22&o=9&p=8&l=as1&asins=%{asins}&ref=tf_til&fc1=000000&IS2=1&lt1=_blank&m=amazon&lc1=0000FF&bc1=000000&bg1=FFFFFF&f=ifr"
+          style="float:right; width:120px;height:240px;"
+          scrolling="no" marginwidth="0" marginheight="0" frameborder="0"
+          ></iframe>
+      EOS
+
+      def self.conf_template
+        <<EOM
+# Amazon association link with any ASIN can be rendered
+# at any location in juli text.  Its template is as follows.
+# This HTML is just an example so that you can change as you like.
+# '%{asins}' in the template will be replaced by actual ASIN:
+#
+#amazon:     '<iframe src="http://rcm-jp.amazon.co.jp/e/cm?o=9&p=8&l=as1&asins=%{asins}&ref=tf_til&fc1=000000&IS2=1&lt1=_blank&m=amazon&lc1=0000FF&bc1=000000&bg1=FFFFFF&f=ifr" style="float:right; width:120px;height:240px;" scrolling="no" marginwidth="0" marginheight="0" frameborder="0"></iframe>'
+EOM
+      end
+
+      def place_holder; 'asins'; end
+    end
+  end
+end

data/lib/juli/macro/jmap.rb

@@ -0,0 +1,38 @@
+# coding: UTF-8
+require 'juli/macro/template_base'
+
+module Juli
+  module Macro
+    # generate Map HTML.
+    #
+    # The purpose of this macro is to provide I/F for map.
+    # When map-site(like google) service is discontinued, or
+    # URL is changed, it is enough to change:
+    #
+    # 1. .juli/config jmap entry or
+    # 1. this macro implementation.
+    #
+    # There is no need to modify all of wiki pages which use 'jmap' macro.
+    #
+    # 'J' of jmap stands for Juli. it is because 'map' in ruby is quite common
+    # method so that necessary to avoid name confusion.
+    #
+    # Currently, Google map is used.
+    class Jmap < TemplateBase
+      # Thank you, http://mapki.com/wiki/Google_Map_Parameters !!
+      DEFAULT_TEMPLATE = '<iframe width="425" height="350" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="http://maps.google.com/maps?q=loc:%{coord}&amp;num=1&amp;ie=UTF8&amp;t=m&amp;z=14&amp;output=embed"></iframe><br /><small><a href="http://maps.google.com/maps?q=loc:%{coord}&amp;num=1&amp;ie=UTF8&amp;t=m&amp;z=14&amp;source=embed" style="color:#0000FF;text-align:left">View Larger Map</a></small>'
+
+      def self.conf_template
+        <<EOM
+# HTML template to draw map.  If not set, default defined at
+# Juli::Macro::Jmap::DEFAULT_TEMPLATE is used.
+# %{coord} in the template wiil be replaced to the actual 1st parameter.
+#
+#jmap: '#{DEFAULT_TEMPLATE}'
+EOM
+      end
+
+      def place_holder; 'coord'; end
+    end
+  end
+end

data/lib/juli/macro/photo.rb

@@ -0,0 +1,161 @@
+require 'fileutils'
+require 'digest/sha1'
+require 'RMagick'
+require 'pp'
+
+module Juli
+  module Macro
+    # embed photo(image) in juli wiki text with minimum maintenance cost
+    #
+    # See 'doc/photo(macro).txt' for the detail.
+    class Photo < Base
+      include Juli::Visitor::Html::TagHelper
+
+      PUBLIC_PHOTO_DIR_DEFAULT  = 'public_photo'
+      SEED_DEFAULT              = '-- Juli seed default!! --'
+      CONF_DEFAULT = {
+        'mount'     => '/home/YOUR_NAME/Photos',
+        'small'     => {
+          'width'   => 512,           # default small width in pixel
+          'style'   => 'float: right'
+        },
+        'large'     => {
+          'width'   => 1024           # default large width in pixel
+        }
+      }
+
+      class DirNameConflict < Juli::JuliError; end
+      class ConfigNoMount   < Juli::JuliError; end
+
+      def self.conf_template
+        <<EOM
+# Photo macro setup sample is as follows.
+#
+#photo:
+# mount:    '#{CONF_DEFAULT['mount']}'
+# small:
+#   width:  #{CONF_DEFAULT['small']['width']}
+#   style:  '#{CONF_DEFAULT['small']['style']}'
+# large:
+#   width:  #{CONF_DEFAULT['large']['width']}
+EOM
+      end
+
+      def set_conf_default(conf)
+        set_conf_default_sub(conf, 'photo', CONF_DEFAULT)
+      end
+
+      # rotate image to fit orientation
+      def rotate(img)
+        exif = img.get_exif_by_entry(:Orientation)
+        return img if !(exif && exif[0] && exif[0][0] == :Orientation)
+        case exif[0][1]
+        when '1'  # Normal
+          img
+        when '6'  #  90 degree
+          img.rotate(90)    # 90[deg] to clock direction
+        when '8'  # 270 degree
+          img.rotate(-90)   # 90[deg] to reversed-clock direction
+        else
+          img
+        end
+      end
+
+      # public photo directory is used to:
+      #
+      # * store converted photo from original one
+      # * protect private photo in 'mount' directory from public web access
+      #   by copying (with conversion) to it on demand.
+      #
+      # === INPUTS
+      # url::   when true, return url, else, return physical file-system path
+      def public_photo_dir(url = true)
+        dir = File.join(conf['output_top'], PUBLIC_PHOTO_DIR_DEFAULT)
+        raise DirNameConflict if File.file?(dir)
+
+        if !File.directory?(dir)
+          FileUtils.mkdir(dir)
+        end
+        url ? PUBLIC_PHOTO_DIR_DEFAULT : dir
+      end
+
+      # simplify path to the non-directory name with size.
+      #
+      # === Example
+      # path::        a/b/c.jpg
+      # photo_name::  a_b_c_#{size}.jpg
+      def photo_name(path, size)
+        flat = path.gsub(/\//, '_')
+        sprintf("%s_%s%s",
+            File.basename(flat, '.*'), size, File.extname(flat))
+      end
+
+      # cached photo path
+      #
+      # === INPUTS
+      # path::  photo-macro path argument
+      # size::  :small, or :large
+      # url::   when true, return url, else, return physical file-system path
+      def photo_path(path, size, url = true)
+        File.join(public_photo_dir(url), photo_name(path, size))
+      end
+
+      # create resized, rotated, and 'exif' eliminated cache when:
+      # 1. not already created, or
+      # 1. cache is obsolete
+      #
+      # and return the path.
+      #
+      # === INPUTS
+      # path::  photo-macro path argument
+      # size::  :small, or :large
+      # url::   when true, return url, else, return physical file-system path
+      def intern(path, size = :small, url = true)
+        protected_path    = File.join(conf_photo['mount'], path)
+        public_phys_path  = photo_path(path, size, false)
+        if !File.exist?(public_phys_path) ||
+            File::Stat.new(public_phys_path).mtime < File::Stat.new(protected_path).mtime
+
+          img     = Magick::ImageList.new(protected_path)
+          width   = (s = conf_photo[size.to_s]) && s['width']
+          img.resize_to_fit!(width, img.rows * width / img.columns)
+          self.rotate(img).
+              strip!.
+              write(public_phys_path).destroy!
+        end
+        photo_path(path, size, url)
+      end
+
+      # return <img...> HTML tag for the photo with this macro features.
+      def run(*args)
+        path      = args[0].gsub(/\.\./, '')     # sanitize '..'
+        style     = conf_photo['small']['style']
+        small_url = intern(path)
+        large_url = intern(path, :large)
+        content_tag(:a, :href=>large_url) do
+          tag(:img,
+              :src    => intern(path),
+              :class  => 'juli_photo_small',
+              :style  => style)
+        end
+      end
+
+      def conf_photo
+        @conf_photo ||= conf['photo']
+      end
+
+    private
+      def set_conf_default_sub(hash, key, val)
+        case val
+        when Hash
+          hash[key] = {} if !hash[key]
+          for k, v in val do
+            set_conf_default_sub(hash[key], k, v)
+          end
+        else
+          hash[key] = val if !hash[key]
+        end
+      end
+    end
+  end
+end

data/lib/juli/macro/tag.rb

@@ -0,0 +1,136 @@
+# coding: UTF-8
+
+require 'sdbm'
+
+module Juli
+  module Macro
+    # Register tags of this document for tag-search.
+    #
+    # See 'doc/tag(macro).txt' for the detail how to use it.
+    # Here is the implementation document.
+    #
+    # === Tag-DB ER-chart
+    # tag <--->> tag_page <<---> page
+    #
+    # * tag DB value counts number of wikipages
+    #
+    # === FILES
+    # JURI_REPO/.juli/tag.sdbm::      tag DB
+    # JURI_REPO/.juli/page.sdbm::     page DB
+    # JURI_REPO/.juli/tag_page.sdbm:: tag-page intersection DB
+    class Tag < Base
+      SEPARATOR = '_, _'
+      NO_TAG    = '_no_tag_'
+
+      attr_accessor :tag_db, :page_db, :tag_page_db
+
+      def initialize
+        super
+
+        repo_dir      = File.join(juli_repo, Juli::REPO)
+        @tag_db       = SDBM.open(File.join(repo_dir, 'tag.sdbm'))
+        @page_db      = SDBM.open(File.join(repo_dir, 'page.sdbm'))
+        @tag_page_db  = SDBM.open(File.join(repo_dir, 'tag_page.sdbm'))
+      end
+
+      # register page
+      def on_root(file, root, visitor = nil)
+        @wikiname           = Juli::Util::to_wikiname(file)
+        @page_db[@wikiname] = '1'
+        @tag_exists         = false
+      end
+
+      def run(*args)
+        for tag in args do
+          @tag_exists   = true
+
+          # +1 on tag
+          @tag_db[tag]  = ((@tag_db[tag] || '0').to_i + 1).to_s
+          if @wikiname
+            @tag_page_db[tag_page_key(tag, @wikiname)] = '1'
+          end
+        end
+        ''
+      end
+
+      # follow-up process to register 'no-tag' if there is no tag in the
+      # file.
+      def after_root(file, root)
+        key = sprintf("%s%s%s", @wikiname, SEPARATOR, NO_TAG)
+        if @tag_exists
+          @tag_page_db.delete(key)
+        else
+          @tag_page_db[key] = '1'
+        end
+      end
+
+      # value in sdbm in ruby 1.9 looks not to support encoding
+      # (in other words, always set to ASCII-8BIT) so that
+      # enforce to set it to UTF-8.
+      def to_utf8(v)
+        v.force_encoding(Encoding::UTF_8)
+      end
+
+      # return pages associated with key
+      def pages(key)
+        result = []
+        for tag_page, val in @tag_page_db do
+          if to_utf8(tag_page) =~ /^(.*)#{SEPARATOR}#{key}$/
+            result << $1
+          end
+        end
+        result
+      end
+
+      def max_tag_weight
+        @tag_db.values.map{|v| v.to_i}.max || 1
+      end
+
+      # return 0..10 in tag weight v.s. max-weight
+      def tag_weight_ratio(key)
+        v = (@tag_db[key] || '0').to_i
+        (v * 10 / max_tag_weight).to_i
+      end
+
+      # delete entry from DB
+      def delete_page(file)
+        wikiname = Juli::Util::to_wikiname(file)
+        @page_db.delete(wikiname)
+
+        tag_on_the_file = {}
+        for tag, val in @tag_db.keys do
+          if @tag_page_db[tag_page_key(tag, wikiname)]
+            tag_on_the_file[tag] = 1
+          end
+        end
+
+        # -1 on tag
+        for tag in tag_on_the_file.keys do
+          @tag_db[tag]  = ((@tag_db[tag] || '1').to_i - 1).to_s
+        end
+      end
+
+      # print DB info; debugging purpose.  How to use:
+      #
+      #   $ test/console
+      #   > Dir.chdir('../test/repo')
+      #   > include Juli::Util
+      #   > t = Juli::Macro::Tag.new
+      #   > t.dump
+      def dump
+        for db in %w(tag_db page_db tag_page_db) do
+          printf("%s\n", db)
+          for key, val in instance_variable_get('@' + db) do
+            printf("  %s\t%s\n", key, val)
+          end
+          print "\n"
+        end
+      end
+
+    private
+      def tag_page_key(tag, wikiname)
+        sprintf("%s%s%s", wikiname, SEPARATOR, tag)
+      end
+    end
+  end
+end

data/lib/juli/macro/template.rb

@@ -0,0 +1,37 @@
+# coding: UTF-8
+
+require 'sdbm'
+
+module Juli
+  module Macro
+    # set ERB template.
+    #
+    # ERB template, which is used on generating HTML from juli-formatted text,
+    # can be specified by:
+    #
+    # 1. juli(1) command line -t option.
+    # 1. this macro
+    # 1. .juli/config template directive.
+    # 1. lib/juli/template
+    #
+    # See 'doc/template(macro).txt' for the detail how to use it.
+    # Here is the implementation document.
+    #
+    # NOTE: Template class is <b>totally different</b> from TemplateBase.
+    # Template is to specify ERB template, while TemplateBase is the
+    # base class to provide HTML flagment replacement in a juli document.
+    class Template < Base
+      # save visitor for later use at run()
+      def on_root(file, root, visitor = nil)
+        @visitor = visitor
+      end
+
+      def run(*args)
+        if @visitor.respond_to?('template=')
+          @visitor.template = args[0]
+        end
+        ''
+      end
+    end
+  end
+end

data/lib/juli/macro/template_base.rb

@@ -0,0 +1,44 @@
+module Juli
+  module Macro
+    # Base class for HTML template related macros.
+    #
+    # Derived class can provide HTML template replacement with minimum
+    # implementation.  Please see Wikipedia case as an example.
+    class TemplateBase < Base
+      DEFAULT_TEMPLATE = ''
+
+      def self.conf_template
+        ''
+      end
+
+      # return key string used for conf-key
+      #
+      # Please overwrite this method if it is not just underscore-ed.
+      def conf_key
+        Juli::Util::underscore(self.class.to_s)
+      end
+
+      # set default value in conf if no .juli/conf defined.
+      #
+      # Please overwrite this method when this implementation is not your
+      # case.
+      def set_conf_default(conf)
+        if !conf[conf_key]
+          conf[conf_key] = self.class::DEFAULT_TEMPLATE
+        end
+      end
+
+      # return string used to be replaced with %{...} in conf[conf_key] string.
+      #
+      # Please overwrite this method if it is not just underscore-ed.
+      def place_holder
+        conf_key
+      end
+
+      def run(*args)
+        template = conf[conf_key]
+        template.gsub("%{#{place_holder}}", args[0])
+      end
+    end
+  end
+end