juli 2.0.0

data/lib/juli/visitor/html/helper.rb

@@ -0,0 +1,97 @@
+require 'i18n'
+
+class Juli::Visitor::Html
+  # This provides methods used in HTML Erb; called 'helper'.
+  #
+  # Any method here can be used at ERB template under LIB/juli/template/.
+  # Where, LIB is 'lib/' directory in package environment, or
+  # one of $LOAD_PATH in installed environment.
+  #
+  # === How to add new helper(1)
+  # If new method is added in this module, it can be used as helper at
+  # template ERB file.  This is the simplest case.
+  #
+  # === How to add new helper(2)
+  # If some preparation is required before calling helper, above way is not
+  # enough.  For example, recent_update() helper requires file list
+  # which is sorted by descendant order of mtime timestamp.
+  # It is time-consuming task to prepare such a file list on every
+  # recent_update() calling.  It is enough to do that only once when juli(1)
+  # is executed.
+  #
+  # Another example: if the same helper is called more than once in one
+  # template, it could be effective to reduce the CPU resource to
+  # prepare some data and store it in the helper class instance then
+  # each helper uses it just to print the result.
+  #
+  # Juli supports such a case.  Let me assume here to write 
+  # 'weather_forecast' helper, which draws some local area's
+  # one week weather forecast (juli(1) is offline wiki so that
+  # this kind of realtime information is not a good example though...).
+  # Follow the steps below:
+  # 1. Write WeatherForecast helper class file as
+  #    LIB/juli/visitor/html/helper/weather_forecast.rb.
+  #    (recent_update.rb could be a reference for this.)
+  # 1. WeatherForecast should inherit
+  #    Juli::Visitor::Html::Helper::AbstractHelper.
+  # 1. implement each method: initialize, on_root, run.
+  #
+  # Then, weather_forecast method can be used in ERB template.
+  # This method is dynamically defined at Html visitor and equivalent 
+  # to WeatherForecast#run.
+  #
+  module Helper
+    class AbstractHelper
+      include Juli::Util
+
+      # called on 'juli init' to generate config sample template.
+      def self.conf_template
+        ''
+      end
+
+      # called when juli(1) starts.
+      def initialize
+      end
+
+      # called on setting up conf to set default key=val
+      def set_conf_default(conf)
+      end
+
+      # called on each parsed document
+      def on_root(in_file, root, visitor)
+      end
+
+      # This will be a helper like 'abstract_helper(args)'
+      def run(*args)
+      end
+    end
+
+    # TRICKY PART: header_id is used for 'contents' helper link.
+    # Absyn::HeaderNode.dom_id cannot be used directory for
+    # this purpose since when clicking a header of 'contents',
+    # document jumps to its contents rather than header so that
+    # header is hidden on browser.  To resolve this, header_id
+    # is required for 'contents' helper and it is set at Html visitor.
+    def header_id(n)
+      "#{n.dom_id}_header"
+    end
+
+    # dest's relative path from src
+    #
+    # === EXAMPLE
+    # relative_from('a.txt',   'juli.js'):: → './juli.js'
+    # relative_from('a/b.txt', 'juli.js'):: → '../juli.js'
+    def relative_from(src, dest)
+      result = []
+      Pathname.new(File.dirname(src)).descend{|dir|
+        result << (dir.to_s == '.' ? '.' : '..')
+      }
+      File.join(result, dest)
+    end
+
+    # import all of helper/*.rb files
+    Dir.glob(File.join(File.dirname(__FILE__), 'helper/*.rb')){|v|
+      require File.join('juli/visitor/html/helper', File.basename(v))
+    }
+  end
+end

data/lib/juli/visitor/html/helper/contents.rb

@@ -0,0 +1,76 @@
+module Juli::Visitor::Html::Helper
+  # Helper-class for 'contents' helper
+  class Contents < AbstractHelper
+    # Check if chapter exists or not
+    class ChapterChecker < Juli::Absyn::Visitor
+      attr_accessor :chapter_exists
+
+      def initialize(opts = {})
+        @chapter_exists = false
+        super
+      end
+
+      def visit_chapter(n)
+        @chapter_exists = true
+      end
+    end
+
+    class ContentsDrawer < Juli::Absyn::Visitor
+      include Juli::Visitor::Html::TagHelper
+      include Juli::Visitor::Html::Helper
+
+      def visit_node(n); ''; end
+      def visit_str(n); ''; end
+      def visit_verbatim(n); ''; end
+      def visit_ordered_list(n); ''; end
+      def visit_unordered_list(n); ''; end
+      def visit_compact_dictionary_list(n); ''; end
+      def visit_compact_dictionary_list_item(n); ''; end
+      def visit_dictionary_list(n); ''; end
+      def visit_dictionary_list_item(n); ''; end
+  
+      def visit_array(n)
+        n.array.inject(''){|result, child|
+          result += child.accept(self)
+        }
+      end
+
+      def visit_chapter(n)
+        content_tag(:li) do
+          content_tag(:a, :href=>'#' + header_id(n)) do
+            n.str
+          end +
+          content_tag(:ol) do
+            n.blocks.accept(self)
+          end
+        end
+      end
+    end
+
+    # called on each parsed document
+    def on_root(in_file, root, visitor = nil)
+      @root = root
+    end
+
+    # implementation of:
+    #   contents
+    #
+    # which draws contents(a.k.a. outline) of this document.
+    #
+    # This visits document tree by ContentsDrawer visitor and
+    # generate HTML contents list.
+    def run(*args)
+      contents_drawer = ContentsDrawer.new
+      chapter_checker = ChapterChecker.new
+      @root.accept(chapter_checker)
+      if chapter_checker.chapter_exists
+        contents_drawer.content_tag(:b, I18n.t('contents')) +
+        contents_drawer.content_tag(:ol) do
+          @root.accept(contents_drawer)
+        end
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/juli/visitor/html/helper/fb_comments.rb

@@ -0,0 +1,68 @@
+module Juli::Visitor::Html::Helper
+  # Helper-class for 'fb_like' helper
+  class FbComments < AbstractHelper
+    # default HTML template for facebook 'like' button.
+    # You can customize it in .juli/config facebook.like.template entry.
+    #
+    # %{href} in the template will be replaced to the actual URL of
+    # current wiki page.
+    DEFAULT_TEMPLATE =
+      '<fb:comments href="%{href}" num_posts="2" width="470">' +
+      '</fb:comments>'
+
+    # called on 'juli init' to generate config sample template.
+    def self.conf_template
+      <<EOM
+# Facebook related setup is here.
+#
+#url_prefix: 'http://YOUR_HOST/juli'
+#facebook:
+#  like:
+#    template:  '#{Juli::Visitor::Html::Helper::FbLike::DEFAULT_TEMPLATE}'
+#  comments:
+#    template:  '#{DEFAULT_TEMPLATE}'
+EOM
+    end
+
+    def initialize
+      @fb_conf  = conf['facebook']
+    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)
+      conf['url_prefix']  = 'http://YOUR_HOST/juli' if !conf['url_prefix']
+      conf['facebook']    = {}                      if !conf['facebook']
+      if !conf['facebook']['comments']
+        conf['facebook']['comments'] = {
+          'template'  => self.class::DEFAULT_TEMPLATE
+        }
+      end
+      if !conf['facebook']['like']
+        conf['facebook']['like'] = {
+          'template'  => Juli::Visitor::Html::Helper::FbLike::DEFAULT_TEMPLATE
+        }
+      end
+    end
+
+    # called on each parsed document
+    def on_root(in_file, root, visitor = nil)
+      @in_file  = in_file
+    end
+
+    def run(*args)
+      raise Juli::NoConfig if !conf['url_prefix']
+      raise Juli::NoConfig if !@in_file
+
+      template.gsub('%{href}',
+          conf['url_prefix'] + '/' + to_wikiname(@in_file) + conf['ext'])
+    end
+
+  private
+    def template
+      @fb_conf['comments']['template']
+    end
+  end
+end

data/lib/juli/visitor/html/helper/fb_like.rb

@@ -0,0 +1,37 @@
+module Juli::Visitor::Html::Helper
+  # Helper-class for 'fb_like' helper
+  class FbLike < AbstractHelper
+    # default HTML template for facebook 'like' button.
+    # You can customize it in .juli/config facebook.like.template entry.
+    #
+    # %{href} in the template will be replaced to the actual URL of
+    # current wiki page.
+    DEFAULT_TEMPLATE =
+      '<fb:like href="%{href}" ' +
+          'send="false" layout="button_count" width="450" ' +
+          'show_faces="false">' +
+          '</fb:like>'
+
+    def initialize
+      @fb_conf  = conf['facebook']
+    end
+
+    # called on each parsed document
+    def on_root(in_file, root, visitor = nil)
+      @in_file  = in_file
+    end
+
+    def run(*args)
+      raise Juli::NoConfig if !conf['url_prefix']
+      raise Juli::NoConfig if !@in_file
+
+      template.gsub('%{href}',
+          conf['url_prefix'] + '/' + to_wikiname(@in_file) + conf['ext'])
+    end
+
+  private
+    def template
+      @fb_conf['like']['template']
+    end
+  end
+end

data/lib/juli/visitor/html/tag_helper.rb

@@ -0,0 +1,40 @@
+class Juli::Visitor::Html
+    # copied from Rails
+    module TagHelper
+      def tag(name, options = nil, open = false)
+        "<#{name}#{tag_options(options) if options}#{open ? ">" : " />"}"
+      end
+    
+      def content_tag(name, content_or_options_with_block = nil, options = nil, &block)
+        if block_given?
+          options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
+          content_tag_string(name, block.call, options)
+        else
+          content_tag_string(name, content_or_options_with_block, options)
+        end
+      end
+    
+    private
+      BOOLEAN_ATTRIBUTES = %w(disabled readonly multiple checked)
+      BOOLEAN_ATTRIBUTES << BOOLEAN_ATTRIBUTES.map{|s| s.to_sym}
+    
+      def content_tag_string(name, content, options)
+        tag_options = tag_options(options) if options
+        "<#{name}#{tag_options}>#{content}</#{name}>"
+      end
+    
+      def tag_options(options)
+        if options != {}
+          attrs = []
+          options.each_pair do |key, value|
+            if BOOLEAN_ATTRIBUTES.include?(key)
+              attrs << key if value
+            else
+              attrs << %(#{key}="#{value}") if !value.nil?
+            end
+          end
+          " #{attrs.sort * ' '}" unless attrs.empty?
+        end
+      end
+    end
+end

data/lib/juli/visitor/slidy.rb

@@ -0,0 +1,39 @@
+module Juli::Visitor
+  # This visits Absyn tree and generates HTML for Slideshow.
+  #
+  # Text files under juli-repository must have '.txt' extention.
+  #
+  # Almost all are the same as Html VISITOR.
+  #
+  # === OPTIONS
+  # -t template::   specify template
+  class Slidy < Html
+    # bulk-mode for slideshow generation doesn't make sense so that
+    # it just warns and return quickly.
+    def run_bulk
+      STDERR.printf("bulk-mode in Slidy is not supported.\n")
+    end
+
+    # overwrite to:
+    # * add 'slide' stylesheet-class at level==1
+    # * include all contents in 'slide' stylesheet-class even title
+    def visit_chapter(n)
+      attr = {:id=>n.dom_id}
+      if n.level==1
+        attr.merge!(:class=>'slide')
+      end
+      content_tag(:div, attr) do
+        header_link(n) +
+        n.blocks.accept(self)
+      end + "\n"
+    end
+
+  private
+    # overwrite to generate simple <h#>...</h#>
+    def header_link(n)
+      content_tag("h#{n.level + 1}") do
+        @header_sequence.gen(n.level) + '. ' + n.str
+      end + "\n"
+    end
+  end
+end

data/lib/juli/visitor/takahashi_method.rb

@@ -0,0 +1,41 @@
+module Juli::Visitor
+  # This visits Absyn tree and generates HTML for
+  # 'Takahashi method' slideshow.
+  #
+  # Text files under juli-repository must have '.txt' extention.
+  #
+  # Almost all are the same as Html VISITOR.
+  #
+  # === OPTIONS
+  # -t template::   specify template
+  class TakahashiMethod < Html
+    # bulk-mode in TakahashiMethod doesn't make sense so that
+    # it just warns and return quickly.
+    def run_bulk
+      STDERR.printf("bulk-mode in TakahashiMethod is not supported.\n")
+    end
+
+  private
+    # overwrite to generate simple <h# class=slide>...</h#>
+    def header_link(n)
+      content_tag("h#{n.level + 1}", :class=>'slide') do
+        @header_sequence.gen(n.level) + '. ' + n.str
+      end + "\n"
+    end
+
+    # specify paragraph css
+    def paragraph_css
+      {:class=>'default slide'}
+    end
+
+    # specify blockquote css
+    def blockquote_css
+      {:class=>'slide'}
+    end
+
+    # specify list item css
+    def list_item_css
+      {:class=>'slide'}
+    end
+  end
+end

data/lib/juli/visitor/tree.rb

@@ -0,0 +1,135 @@
+require 'juli/absyn'
+require 'juli/util'
+require 'juli/line_parser.tab'
+
+module Juli::Visitor
+  class LineTree < Juli::LineAbsyn::Visitor
+    include Juli::Util
+
+    def initialize(depth)
+      @depth = depth
+    end
+
+    def print_depth
+      print '| ' * @depth
+    end
+
+    def visit_string(n)
+      print_depth
+      printf "str:  %s\n", str_trim(n.str)
+    end
+
+    def visit_wikiname(n)
+      print_depth
+      printf "wiki: %s\n", str_trim(n.str)
+    end
+
+    def visit_url(n)
+      print_depth
+      printf "url:  %s\n", str_trim(n.str)
+    end
+  end
+
+  # Another VISITOR-pattern for Absyn tree to print tree
+  # structure around each node.
+  class Tree < Juli::Absyn::Visitor
+    include Juli::Util
+
+    # visit root to generate absyn-tree structure.
+    def run_file(in_file, root)
+      @depth = 0
+      super
+    end
+  
+    def visit_str(n)
+      print_depth
+      printf("StrNode(%d)\n", -1)
+      @depth += 1
+        process_str(n.str)
+      @depth -= 1
+    end
+
+    def visit_verbatim(n)
+      print_depth
+      printf("verbatim: %s\n", str_trim(n.str))
+    end
+
+    def visit_array(n)
+      print_depth
+      printf("Array\n")
+      @depth += 1
+      for child in n.array do
+        child.accept(self)
+      end
+      @depth -= 1
+    end
+
+    def visit_chapter(n)
+      print_depth
+      printf("Chapter(%d %s)\n", n.level, n.str)
+      @depth += 1
+      n.blocks.accept(self)
+      @depth -= 1
+    end
+
+    def visit_ordered_list(n)
+      visit_list("OrderedList\n", n)
+    end
+
+    def visit_unordered_list(n)
+      visit_list("UnorderedList\n", n)
+    end
+
+    def visit_compact_dictionary_list(n)
+      visit_list("CompactDictionaryList\n", n)
+    end
+
+    def visit_compact_dictionary_list_item(n)
+      visit_x_dictionary_list_item(n, "CompactDictionaryListItem\n")
+    end
+
+    def visit_dictionary_list(n)
+      visit_list("DictionaryList\n", n)
+    end
+
+    def visit_dictionary_list_item(n)
+      visit_x_dictionary_list_item(n, "DictionaryListItem\n")
+    end
+
+    def visit_quote(n)
+      print_depth
+      printf("QuoteNode(%s)\n", str_trim(n.str))
+    end
+
+  private
+    def print_depth
+      print '| ' * @depth
+    end
+  
+    def visit_list(class_str, n)
+      print_depth
+      printf(class_str)
+      @depth += 1
+      for child in n.array do
+        child.accept(self)
+      end
+      @depth -= 1
+    end
+
+    # common for both dictionary list item and compact dictionary list item
+    def visit_x_dictionary_list_item(n, node_name)
+      print_depth
+      printf(node_name)
+      @depth += 1
+      process_str(n.term)
+      process_str(n.str)
+      @depth -= 1
+    end
+
+    # str -> Juli::LineAbsyn -> print with depth
+    def process_str(str)
+      Juli::LineParser.new.parse(str, Juli::Wiki.wikinames).
+          accept(LineTree.new(@depth))
+    end
+  end
+end