hikiutils 0.2.3.6 → 0.2.3.7

data/hikiutils_yamane/purpose.hiki

@@ -0,0 +1,18 @@
+!!目的
+本研究ではhikiの編集作業をより容易にするためのツールの開発を行った． 
+hikiは通常web上で編集を行っているが,GUIとCUIが混在しており,操作に不便な点がある. 
+そこで,編集操作が CUI で完結するために開発をされたのが hikiutils である. 
+しかし,そのユーザインタフェースにはコマンドが直感的でないという問題点がある. 
+そこで，Thorというコマンドラインツール作成ライブラリを用いる．
+optparseというコマンドライン解析ライブラリを使用しているhikiutilsを新たなコマンドライン解析ライブラリを使用することコマンドを書き換え，より直感的なコマンドにして使いやすくする．
+!!既存システムの説明
+図に従ってhiki systemの動作概要を説明する．
+
+!!!caption:hiki web systemとhiki systemの対応関係．
+{{attach_view(hikiutils_yamane_09_copy.001.jpg,hikiutils_yamane)}}
+
+hikiは，hiki記法を用いたwiki cloneです．wikiはウォード・カニンガムが作ったwikiwikiwebを源流とするhome page制作を容易にするシステムで，hikiもwikiの基本要求仕様を満足するシステムを提供しています．wikiの特徴であるweb上で編集する機能を提供しています．これを便宜上hiki web systemと呼びます．図にある通り，一般的な表示画面の他に，編集画面が提供されており，ユーザーはこの編集画面からコンテンツを編集することが可能です．リンクやヘッダー，リスト，引用，表，図の表示などの基本テキストフォーマットが用意されています．
+
+hiki web systemの実際の基本動作は，hiki.cgiプログラムを介して行われています．こちらを便宜上hiki systemと呼びます．hiki systemは，data/textに置かれた書かれたプレーンテキストをhtmlへ変換します．この変換はhikidoc[1-1]というhikiフォーマットconverterを使っています．また，添付書類はcache/attachに，一度フォーマットしたhtmlはparserに置かれており，それらを参照してhtmlを表示する画面をhiki.cgiは作っています．さらにhiki systemでは検索機能，自動リンク作成などが提供されています
+
+研究室内の内部文書，あるいは外部への宣伝資料，さらにwikipediaのように重要な研究成果の発信などに西谷研ではこのhiki systemを利用しています．初心者にも覚えやすい直感的な操作です．しかし，慣れてくるとテキスト編集や画面更新にいちいちweb画面へ移行せねばならず，編集の思考が停止します．そこで，テキスト編集に優れたeditorとの連携や，terminal上のshell commandと連携しやすいようにhikiutilsというcli(command line interface)を作成して運用しています．このhikiutilsのコマンドオプションの実装をしなおして，より使いやすくすることが本研究の目的です．

data/hikiutils_yamane/results.hiki

@@ -15,14 +15,18 @@ hikiutilsの振る舞いを予測できるシェルコマンドと同じ名前
 
 !!!hikiutilsがあらかじめ想定している利用形態
 ここでhikiutilsがあらかじめ想定している利用形態を解説しておきます．
+
 !!!!caption:hikiutilsがあらかじめ想定している利用形態
-{{attach_view(hikiutils_yamane.007.jpeg,hikiutils_yamane)}}
-hikiutilsはlocal PCとglobal serverとが用意されており，それらのデータをrsyncで
-同期することで動作することを想定しています．これは，ネットに繋がっていないオフラインの状況でも
-テキストなどの編集ができ，さらに不用意な書き換えを防ぐための機構です．さらに，
-どちらもがバックアップともなっています．
+{{attach_view(hikiutils_yamane_09_copy.002.jpg,hikiutils_yamane)}}
+
+hikiutilsは，
+*local PCとglobal serverとが用意されており，
+*それらのデータをrsyncで同期する
+ことで動作することを想定しています．これは，ネットに繋がっていないオフラインの状況でも
+テキストなどの編集が可能で，さらに不用意な書き換えを防ぐための機構です．さらに，
+どちらもが何かあった時のバックアップともなって，ミスによる手戻りを防いでいます．
 
-これらの設定は，~/.hikircにyaml形式で保存されています．
+これらの設定は，~/.hikircにyaml形式で記述・保存されています．
 <<< yaml
 bob% cat ~/.hikirc
 :srcs:
@@ -89,7 +93,7 @@ local_dirにあるファイル名を[FILE*]として表示．例えば，hikiuti
 !!!! rsync
 local_dirの内容をglobal_dirにrsyncする．逆方向は同期に誤差が生じたり，permissionが
 おかしくなるので，現在のところ一方向の同期のみとしている．したがって，作業手順としては
-テキストの変更はlocal_dirで飲み行うようにしている．
+テキストの変更はlocal_dirで読み行うようにしている．
 
 !!!! touch FILE
 loccal_dirで書き換えたFILEの内容をlocal_uriに反映させ，ブラウザで表示．シェルコマンドの
@@ -103,274 +107,4 @@ nick_nameの一覧とtargetを表示，current targetをcurrent dirとみなし
 targetを変える，change directoryとのメタファ．ただし，いまのところnick_nameでは
 対応しておらず，nick_nameの番号をVAL入力することで変更する．
 
-!!thorとoptparseのコードの比較
-hikiutilsのコマンドライン解析ツールをoptparseからthorに換えることでコマンドの書き換えを行うことができた．
-また，プログラムのコードもoptparseよりthorのほうが短く書け，簡単にコマンドを作成することができた．
-!!!Thorとは
-Thorとは，コマンドラインツールの作成を支援するライブラリのことである．
-gitやbundlerのようにサブコマンドを含むコマンドラインツールを簡単に作成することができる[4]．
-!!!!Thorの基本的な流れ
-#Thorを継承したクラスのパブリックメソッドがコマンドになる
-#クラス.start(ARGV)でコマンドラインの処理をスタートする
-という流れである[4].
-!!!optparseとは
-optparseモジュールとは，getoptよりも簡便で，柔軟性に富み，かつ強力なコマンドライン解析ライブラリである．
-optparseでは，より宣言的なスタイルのコマンドライン解析手法，すなわちOptionParserのインスタンスでコマンドラインを解析するという手法をとっている．
-これを使うと，GNU/POSIX構文でオプションを指定できるだけでなく，使用法やヘルプメッセージの生成も行える[5]．
-!!!!optparseの基本的な流れ
-#OptionParserオブジェクトoptを生成する
-#オプションを取り扱うブロックをoptに登録する
-#opt.parse(ARGV)でコマンドラインを実際にparseする
-という流れである[6].
-!!!コードの解説
-!!!!Thorの定義                                                      
-{{attach_view(hikiutils_yamane.003.jpg,hikiutils_yamane)}}
-#Hikithor::CLI.start(ARGV)が呼ばれる
-#initializeメソッドが呼ばれる
-#これではThorのinitializeメソッドが呼ばれない
-#superを書くことでThorのinitializeメソッドが呼ばれる
-optparseではrequireでoptparseを呼ぶだけでいいが，ThorではrequireでThorを呼びCLIクラスで継承しinitializeメソッドにsuperを書くことでThorのinitializeを呼ぶ必要がある．
-!!!!!実際のコード
-<<< ruby
-# -*- coding: utf-8 -*-                                                         
-require 'thor'
-require 'kconv'
-require 'hikidoc'
-require 'erb'
-require "hikiutils/version"
-require "hikiutils/tmarshal"
-require "hikiutils/infodb"
-require 'systemu'
-require 'fileutils'
-require 'yaml'
-require 'pp'
-
-module Hikithor
-
-  DATA_FILE=File.join(ENV['HOME'],'.hikirc')
-  attr_accessor :src, :target, :editor_command, :browser, :data_name, :l_dir
-
-  class CLI < Thor
-   def initialize(*args)
-      super
-      @data_name=['nick_name','local_dir','local_uri','global_dir','global_uri']
-      data_path = File.join(ENV['HOME'], '.hikirc')
-      DataFiles.prepare(data_path)
-
-      file = File.open(DATA_FILE,'r')
-      @src = YAML.load(file.read)
-      file.close
-      @target = @src[:target]
-      @l_dir=@src[:srcs][@target][:local_dir]
-      browser = @src[:browser]
-      @browser = (browser==nil) ? 'firefox' : browser
-      p editor_command = @src[:editor_command]
-      @editor_command = (editor_command==nil) ? 'open -a mi' : editor_command
-   end
->>>
-!!!!hikiutilsの実行
-*Thor
-{{attach_view(hikiutils_yamane.004.jpg,hikiutils_yamane)}}{{br}}
-#hiki_thorのHikithor::CLI.start(ARGV)でhikiutils_thor.rbのCLIクラスを呼ぶ{{br}}
-#hikiutils_thor.rbのCLIクラスのメソッドを順に実行していく{{br}}
-*optparse
-{{attach_view(hikiutils_yamane.001.jpg,hikiutils_yamane)}}
-#HikiのHikiUtils::Command.run(ARGV)でhikiutils.rbのrunメソッドを呼ぶ
-#new(argv).executeでexecuteメソッドが実行される
-このようにoptparseでは実行を行うためのメソッドが必要であるが，Thorではクラスのメソッドを順に実行していくため
-runメソッドとexecuteメソッドは必要ない．
-!!!!!実際のコード
-*Thor
-<<< ruby
-#!/usr/bin/env ruby                                                             
-
-require "hikiutils_thor"
-
-Hikithor::CLI.start(ARGV)
->>>
-<<< ruby
-# -*- coding: utf-8 -*-                                                         
-require 'thor'
-require 'kconv'
-require 'hikidoc'
-require 'erb'
-require "hikiutils/version"
-require "hikiutils/tmarshal"
-require "hikiutils/infodb"
-require 'systemu'
-require 'fileutils'
-require 'yaml'
-require 'pp'
-
-module Hikithor
-
-  DATA_FILE=File.join(ENV['HOME'],'.hikirc')
-  attr_accessor :src, :target, :editor_command, :browser, :data_name, :l_dir
-
-  class CLI < Thor
-   def initialize(*args)
-      super
-      @data_name=['nick_name','local_dir','local_uri','global_dir','global_uri']
-      data_path = File.join(ENV['HOME'], '.hikirc')
-      DataFiles.prepare(data_path)
-
-      file = File.open(DATA_FILE,'r')
-      @src = YAML.load(file.read)
-      file.close
-      @target = @src[:target]
-      @l_dir=@src[:srcs][@target][:local_dir]
-      browser = @src[:browser]
-      @browser = (browser==nil) ? 'firefox' : browser
-
->>>
-*optparse
-<<< ruby
-#!/usr/bin/env ruby                                                             
-
-require "hikiutils"
-
-HikiUtils::Command.run(ARGV)
->>>
-<<< ruby
-    def self.run(argv=[])
-      print "hikiutils: provide utilities for helping hiki editing.\n"
-      new(argv).execute
-    end
-
-    def execute
-      @argv << '--help' if @argv.size==0
-      command_parser = OptionParser.new do |opt|
-        opt.on('-v', '--version','show program Version.') { |v|
-          opt.version = HikiUtils::VERSION
-          puts opt.ver
-        }
-        opt.on('-s', '--show','show sources') {show_sources}
-        opt.on('-a', '--add','add sources info') {add_sources }
-        opt.on('-t', '--target VAL','set target id') {|val| set_target(val) }
-        opt.on('-e', '--edit FILE','open file') {|file| edit_file(file) }
-        opt.on('-l', '--list [FILE]','list files') {|file| list_files(file) }
-        opt.on('-u', '--update FILE','update file') {|file| update_file(file) }
-        opt.on('-r', '--rsync','rsync files') {rsync_files}
-        opt.on('--database FILE','read database file') {|file| db_file(file)}
-        opt.on('--display FILE','display converted hikifile') {|file| display(f\
-ile)}
-        opt.on('-c', '--checkdb','check database file') {check_db}
-        opt.on('--remove FILE','remove file') {|file| remove_file(file)}
-        opt.on('--move FILES','move file1,file2',Array) {|files| move_file(file\
-s)}
-        opt.on('--euc FILE','translate file to euc') {|file| euc_file(file) }
-        opt.on('--initialize','initialize source directory') {dir_init() }
-      end
-      begin
-        command_parser.parse!(@argv)
-      rescue=> eval
-        p eval
-      end
-      dump_sources
-      exit
-    end  
->>>
-!!!!コマンドの表示と実行
-*Thor
-{{attach_view(hikiutils_yamane.002.jpg,hikiutils_yamane)}}
-#コマンド名，コマンドの説明を一覧に表示させる
-#パブリックメソッドのコマンドを別のコマンド名でも実行できるようにする
-#コマンドの命令の実行コード
-*optparse
-{{attach_view(hikiutils_yamane.005.jpg,hikiutils_yamane)}}
-よって，optparseではOptionParserオブジェクトoptを生成を行い，コマンドをoptに登録して一覧に表示するメソッドとそれぞれコマンドの実行処理が書かれたメソッドがあるが，
-thorではそれぞれのdescで一覧を表示しmapとパブリックメソッドでコマンドの実行処理を行うためコードが短くなる．
-!!!!!実際のコード
-*Thor
-<<< ruby
-    desc 'show,--show', 'show sources'
-    map "--show" => "show"
-    def show
-      printf("target_no:%i\n",@src[:target])
-      printf("editor_command:%s\n",@src[:editor_command])
-      @i_size,@n_size,@l_size,@g_size=3,5,30,15 #i,g_size are fixed             
-      n_l,l_l=0,0
-      @src[:srcs].each_with_index{|src,i|
-        n_l =(n_l= src[:nick_name].length)>@n_size? n_l:@n_size
-        l_l =(l_l= src[:local_dir].length)>@l_size? l_l:@l_size
-      }
-      @n_size,@l_size=n_l,l_l
-      command = Command.new
-      header = command.display_format('id','name','local directory','global uri',@i_size,@n_size,@l_size,@g_size)
-
-      puts header
-      puts '-' * header.size
-
-      @src[:srcs].each_with_index{|src,i|
-        target = i==@src[:target] ? '*':' '
-        id = target+i.to_s
-        name=src[:nick_name]
-        local=src[:local_dir]
-        global=src[:global_uri]
-        puts command.display_format(id,name,local,global,@i_size,@n_size,@l_size,@g_size)
-      }
-    end
->>>
-*optparse
-<<< ruby 
-    def execute
-      @argv << '--help' if @argv.size==0
-      command_parser = OptionParser.new do |opt|
-        opt.on('-v', '--version','show program Version.') { |v|
-          opt.version = HikiUtils::VERSION
-          puts opt.ver
-        }
-        opt.on('-s', '--show','show sources') {show_sources}
-        opt.on('-a', '--add','add sources info') {add_sources }
-        opt.on('-t', '--target VAL','set target id') {|val| set_target(val)}
-        opt.on('-e', '--edit FILE','open file') {|file| edit_file(file) }
-        opt.on('-l', '--list [FILE]','list files') {|file| list_files(file)}
-        opt.on('-u', '--update FILE','update file') {|file| update_file(file) }
-        opt.on('-r', '--rsync','rsync files') {rsync_files}
-        opt.on('--database FILE','read database file') {|file| db_file(file)}
-        opt.on('--display FILE','display converted hikifile') {|file| display(file)}
-        opt.on('-c', '--checkdb','check database file') {check_db}
-        opt.on('--remove FILE','remove file') {|file| remove_file(file)}
-        opt.on('--move FILES','move file1,file2',Array) {|files| move_file(files)}
-        opt.on('--euc FILE','translate file to euc') {|file| euc_file(file)}
-        opt.on('--initialize','initialize source directory') {dir_init() }
-      end
-      begin
-        command_parser.parse!(@argv)
-      rescue=> eval
-        p eval
-      end
-      dump_sources
-      exit
-    end    
-    
-    def show_sources()
-      printf("target_no:%i\n",@src[:target])
-      printf("editor_command:%s\n",@src[:editor_command])
-      check_display_size()
-      header = display_format('id','name','local directory','global uri')
-
-      puts header
-      puts '-' * header.size
-
-      @src[:srcs].each_with_index{|src,i|
-        target = i==@src[:target] ? '*':' '
-        id = target+i.to_s
-        name=src[:nick_name]
-        local=src[:local_dir]
-        global=src[:global_uri]
-        puts display_format(id,name,local,global)
-      }
-    end
 
-    def add_sources
-      cont = {}
-      @data_name.each{|name|
-        printf("%s ? ", name)
-        tmp = gets.chomp
-        cont[name.to_sym] = tmp
-      }
-      @src[:srcs] << cont
-      show_sources
-    end
->>>

data/lib/hikiutils/version.rb

@@ -1,3 +1,3 @@
 module HikiUtils
-  VERSION = "0.2.3.6"
+  VERSION = "0.2.3.7"
 end

data/lib/templates/Rakefile_hiki_sync

@@ -9,8 +9,15 @@ rescue => e
   exit
 end
 dirnames=Dir.pwd.split('/')
-basename = (dirnames[-1]=='hikis')? dirnames[-2] : dirnames[-1]
+$basename = (dirnames[-1]=='hikis')? dirnames[-2] : dirnames[-1]
 $latex_dir= 'latex_dir'
+$section_layer = {}
+
+task :github do
+  status, stdout, stderr = systemu %q( git remote -v |grep origin )
+  p github_dir=stdout.match(/(.+):(.+) \(push\)/)[2]
+  system "open https://github.com/#{github_dir}"
+end
 
 task :default do
   system 'rake -T'
@@ -26,24 +33,51 @@ task :latex_wrap => [:latex_base, :change_wrap] do
   exit
 end
 
-desc "latex conversion whole hiki files in the current dir."
-task :latex_all do
-  p entries=Dir.entries('.')
+def latex_loop(entries,opts={})
   main_file=""
   entries.each{|file|
-    next unless file.include?('.hiki')
+    options={:latex_all=>true}
+    next unless file.split('.')[1]=='hiki'
     next if file.include?('.hikirc')
     f_name =File.basename(file,'.hiki')
-    if f_name==basename
-      option="--listings --head latex_dir/head.tex -p "
-      main_file=f_name
+    if opts[:main]
+      if f_name==$basename
+        options[:latex]="--listings --head latex_dir/head.tex -p "
+        options[:main]=true
+        main_file=f_name
+        convert_to_latex(file, options)
+      end
     else
-      option="-l 1 --listings -b "
+      if f_name!=$basename
+        p level = $section_layer[f_name] || 1
+        options[:latex]="-l #{level} --listings -b "
+        convert_to_latex(file, options)
+      end
     end
-    convert_to_latex(file, option)
   }
+  return main_file
+end
+
+def check_section_layers(lines)
+  p reg_exp = Regexp.new("#{$basename}_(.+)")
+  lines.each{|line|
+    p line
+    if m=line.match(/(!+)\[\[(.+)\]\]/)
+      p count = m[1].count('!')
+      p file_name=m[2].match(reg_exp)[1]
+      $section_layer[file_name]=count
+    end
+  }
+  p $section_layer
+end
+
+desc "latex conversion whole hiki files in the current dir."
+task :latex_all do
+  p entries=Dir.entries('.')
+  main_file = latex_loop(entries,opts={:main=>true})
+  latex_loop(entries)
   cont=""
-  p reg_exp = Regexp.new("#{basename}_(.+)")
+  p reg_exp = Regexp.new("#{$basename}_(.+)")
   File.readlines(File.join($latex_dir,"#{main_file}.tex")).each{|line|
     if line.match(/section{(.+)}/)
       if m=line.match(/\\verb\|(.+)\((.+)\)\|/)
@@ -55,7 +89,7 @@ task :latex_all do
         p m_t=m[1].match(reg_exp)[1]
         line = "\\include{#{m_t}}\n"
       else
-        line = ""
+#        line = ""
       end
     end
     cont << line
@@ -72,26 +106,28 @@ task :latex_base do
   system("open #{$save_name}")
 end
 
-def convert_to_latex(file_name, option=nil)
+def convert_to_latex(file_name, options={})
   p file_name = file_name.include?('.hiki')? file_name : file_name+'.hiki'
   p tex_name = File.basename(file_name,'.hiki')+'.tex'
   p $save_name = ARGV[2] || File.join($latex_dir,tex_name)
   pre_name = File.join($latex_dir,'pre.tex')
   p pre_command = File.exist?(pre_name) ? '--pre '+pre_name : nil
   lines = File.readlines(file_name)
+  check_section_layers(lines) if options[:main]
   cont = ""
   lines.each{|line|
     if m=line.match(/\{\{attach_view\((.*),(.*)\)\}\}/)
       p line="\{\{attach_view\(#{m[1]}\)\}\}\n"
+    elsif options[:latex_all]
+      line="" if line.match(/title:|author:|date:/)
     end
     cont << line
   }
   tf1,tf2='tmp1.txt','tmp2.txt'
   File.open(tf1,'w'){|file| file.print cont}
-  system "hiki2latex #{pre_command} #{option} #{tf1} > #{tf2}"
+  system "hiki2latex #{pre_command} #{options[:latex]} #{tf1} > #{tf2}"
   lines = File.readlines(tf2)
   system "rm #{tf1} #{tf2}"
-
   cont = ""
   lines.each{|line|
     if m=line.match(/\\includegraphics\[width=6cm\]\{(.+)\}/)
@@ -197,15 +233,15 @@ desc "sync0 hikis and figs to hiki directory"
 task :sync0 do
   entries=Dir.entries('.')
   entries[2..-1].each{|source| #cp *.hiki
-    next unless source.include?('.hiki')
+    next unless source.split('.')[1]=='hiki'
     next if source.include?('.hikirc')
     p base = source.split('.')[0]
-    name = (base==basename)? base : basename+'_'+base
+    name = (base==$basename)? base : $basename+'_'+base
     p target = File.join(target_dir,'text',name)
     FileUtils.cp(source,target,:verbose=>true)
   }
   p entries=Dir.entries('./figs') #cp files in figs
-  p target = File.join(target_dir,'cache','attach',basename)
+  p target = File.join(target_dir,'cache','attach',$basename)
   FileUtils.mkdir_p(target,:verbose=>true) unless File.exists?(target)
   entries[2..-1].each{|file|
     p source = File.join('./figs',file)
@@ -213,7 +249,7 @@ task :sync0 do
   }
 
   File.open('./.hikirc','w'){|file|
-    status, stdout, stderr =systemu "hiki -l #{basename}*"
+    status, stdout, stderr =systemu "hiki -l #{$basename}*"
     file.print(target_dir+"\n")
     stdout.split("\n")[3..-1].each{|line|
       file.print line+"\n"
@@ -244,7 +280,7 @@ desc "check previou and current sync"
 task :check_previous do
   current={}
   print "current hiki dir\n"
-  status, stdout, stderr = systemu("hiki -l #{basename}*")
+  status, stdout, stderr = systemu("hiki -l #{$basename}*")
   stdout.split("\n")[3..-1].each{|line|
     p line
     file=   line.split(/\s+/)[-1]