hikiutils 0.2.3.12 → 0.2.3.13

data/hikiutils_yamane/hikiutils_yamane.hiki

@@ -6,24 +6,20 @@
 ![[序論|hikiutils_yamane_introduction]]
 !方法
 //他人の仕事，あるものを探す
-!![[hikiutils_yamane_compare]]
+!![[optparseとthorの比較|hikiutils_yamane_compare]]
 !![[既存のhikiutilsのコマンド解説|hikiutils_yamane_optparse]]
 !結果
 //自分の仕事，ないものをつくる
 !![[コマンドの命名原則|hikiutils_yamane_command]]
 !![[hikiutilsのthorのコード解説|hikiutils_yamane_thor]]
 
-!参考文献
-[1-1] hikidoc, https://rubygems.org/gems/hikidoc/versions/0.1.0, https://github.com/hiki/hikidoc,2017/1/30 アクセス.
-
+!reference:
+:1-1: hikidoc, https://rubygems.org/gems/hikidoc/versions/0.1.0, https://github.com/hiki/hikidoc,2017/1/30 アクセス.
 // 「hiki」,hikiwiki.org/ja/about.html ,2017/1/30 アクセス.
 // 「hikiutils」,https://rubygems.org/gems/hikiutils ,2017/1/30 アクセス.
 // 「The Ruby Toolbox」, CLI Option Parsers,https://www.ruby-toolbox.com/categories/CLI_Option_Parsers ,2017/1/30 アクセス.
-[1-2] 「Thorの使い方まとめ」, http://qiita.com/succi0303/items/32560103190436c9435b ,2017/1/30 アクセス.
-
-[1-3] 「15.5. optparse - コマンドラインオプション解析器」, http://docs.python.jp/2/library/optparse.html ,2017/1/30 アクセス.
-
-[1-4] 「library optparse」, https://docs.ruby-lang.org/ja/latest/library/optparse.html ,2017/1/30 アクセス.
-
+:1-2: 「Thorの使い方まとめ」, http://qiita.com/succi0303/items/32560103190436c9435b ,2017/1/30 アクセス.
+:1-3: 「15.5. optparse - コマンドラインオプション解析器」, http://docs.python.jp/2/library/optparse.html ,2017/1/30 アクセス.
+:1-4: 「library optparse」, https://docs.ruby-lang.org/ja/latest/library/optparse.html ,2017/1/30 アクセス.
 
 

data/hikiutils_yamane/introduction.hiki

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

data/hikiutils_yamane/latex_dir/%CA%FD/313/241.aux

@@ -0,0 +1,21 @@
+\relax 
+\@setckpt{方法}{
+\setcounter{page}{6}
+\setcounter{equation}{0}
+\setcounter{enumi}{0}
+\setcounter{enumii}{0}
+\setcounter{enumiii}{0}
+\setcounter{enumiv}{0}
+\setcounter{footnote}{0}
+\setcounter{mpfootnote}{0}
+\setcounter{part}{0}
+\setcounter{section}{2}
+\setcounter{subsection}{0}
+\setcounter{subsubsection}{0}
+\setcounter{paragraph}{0}
+\setcounter{subparagraph}{0}
+\setcounter{figure}{1}
+\setcounter{table}{0}
+\setcounter{lstnumber}{1}
+\setcounter{lstlisting}{0}
+}

data/hikiutils_yamane/latex_dir/abstract.aux

@@ -1,7 +1,7 @@
 \relax 
-\@writefile{toc}{\contentsline {section}{\numberline {1}概要}{3}}
+\@writefile{toc}{\contentsline {section}{\numberline {1}概要}{4}}
 \@setckpt{abstract}{
-\setcounter{page}{4}
+\setcounter{page}{5}
 \setcounter{equation}{0}
 \setcounter{enumi}{0}
 \setcounter{enumii}{0}

data/hikiutils_yamane/latex_dir/command.aux

@@ -1,19 +1,20 @@
 \relax 
-\@writefile{toc}{\contentsline {subsection}{\numberline {4.1}コマンドの命名原則}{14}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.1}hikiutilsの想定利用形態}{14}}
-\@writefile{lof}{\contentsline {figure}{\numberline {4}{\ignorespaces hikiutilsがあらかじめ想定している利用形態．}}{14}}
-\newlabel{default}{{4}{14}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.2}コメンド名と振る舞いの詳細}{16}}
-\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces }}{16}}
-\newlabel{default}{{1}{16}}
-\@writefile{toc}{\contentsline {paragraph}{open FILE}{16}}
-\@writefile{toc}{\contentsline {paragraph}{ls [FILE]}{17}}
-\@writefile{toc}{\contentsline {paragraph}{rsync}{17}}
-\@writefile{toc}{\contentsline {paragraph}{touch FILE}{17}}
-\@writefile{toc}{\contentsline {paragraph}{pwd}{17}}
-\@writefile{toc}{\contentsline {paragraph}{cd VAL}{17}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {4.1}コマンドの命名原則}{16}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.1}hikiutilsの想定利用形態}{16}}
+\@writefile{lof}{\contentsline {figure}{\numberline {4}{\ignorespaces hikiutilsがあらかじめ想定している利用形態．}}{16}}
+\newlabel{fig:002}{{4}{16}}
+\newlabel{default}{{4}{16}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.2}コメンド名と振る舞いの詳細}{17}}
+\@writefile{toc}{\contentsline {paragraph}{open FILE}{17}}
+\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces }}{18}}
+\newlabel{default}{{1}{18}}
+\@writefile{toc}{\contentsline {paragraph}{ls [FILE]}{18}}
+\@writefile{toc}{\contentsline {paragraph}{rsync}{18}}
+\@writefile{toc}{\contentsline {paragraph}{touch FILE}{18}}
+\@writefile{toc}{\contentsline {paragraph}{pwd}{19}}
+\@writefile{toc}{\contentsline {paragraph}{cd VAL}{19}}
 \@setckpt{command}{
-\setcounter{page}{18}
+\setcounter{page}{20}
 \setcounter{equation}{0}
 \setcounter{enumi}{2}
 \setcounter{enumii}{0}

data/hikiutils_yamane/latex_dir/command.tex

@@ -13,8 +13,9 @@ hikiutilsの振る舞いを予測できるシェルコマンドと同じ名前
 ここでhikiutilsがあらかじめ想定している利用形態を解説しておきます．
 
 \begin{figure}[htbp]\begin{center}
-\includegraphics[width=6cm,bb=0 0 442 432]{../figs/./hikiutils_yamane_09_copy.002.jpg}
+\includegraphics[width=10cm,bb= 0 0 737 553]{../figs/./hikiutils_yamane.002.jpg}
 \caption{hikiutilsがあらかじめ想定している利用形態．}
+\label{fig:002}
 \label{default}\end{center}\end{figure}
 hikiutilsは，
 
@@ -27,7 +28,7 @@ hikiutilsは，
 どちらもが何かあった時のバックアップともなって，ミスによる手戻りを防いでいます．
 
 これらの設定は，~/.hikircにyaml形式で記述・保存されています．
-\begin{lstlisting}[style=]
+\begin{lstlisting}[style=,basicstyle={\scriptsize\ttfamily}]
 bob% cat ~/.hikirc
 :srcs:
 - :nick_name: new_ist
@@ -43,18 +44,18 @@ bob% cat ~/.hikirc
 \end{lstlisting}
 また，一般的に一人のユーザがいくつものまとまりとしてのlocal-globalペアを
 保持して管理することが普通です．それぞれにnicke\_nameをつけて管理しています．
-\begin{lstlisting}[style=]
+\begin{lstlisting}[style=,basicstyle={\scriptsize\ttfamily}]
 bob% hiki -s
 hikiutils: provide utilities for helping hiki editing.
 "open -a mi"
 target_no:1
 editor_command:open -a mi
- id | name      | local directory                               | global uri     
----------------------------------------------------------------------------------
-  0 | new_ist   | /Users/bob/Sites/new_ist_data/ist_data        | http://ist.ksc.k
- *1 | dmz0      | /Users/bob/Sites/nishitani0/Internal/data     | http://nishitani
-  2 | ist       | /Users/bob/Sites/hiki-data/data               | http://ist.ksc.k
-  3 | new_maple | /Users/bob/Sites/new_ist_data/maple_hiki_data | http://ist.ksc.k
+ id | name      | local directory                           | global uri     
+-----------------------------------------------------------------------------
+  0 | new_ist   | /Users/bob/Sites/new_ist_data/ist_data    | http://ist.ksc.k
+ *1 | dmz0      | /Users/bob/Sites/nishitani0/Internal/data | http://nishitani
+  2 | ist       | /Users/bob/Sites/hiki-data/data           | http://ist.ksc.k
+  3 | new_maple | /Users/bob/Sites/new_ist_data/maple_hiki_d| http://ist.ksc.k
 \end{lstlisting}
 とすると，それらの一覧と，いまtargetにしているnick\_nameディレクリが表示されます．
 
@@ -72,17 +73,17 @@ list [FILE]       &ls  &list files  \\
 rsync             &rsync  &rsync files  \\
 update FILE       &touch  &update file  \\
 show              &pwd  &show nick\_names  \\
-target VAL        &cd  &targetを変える，change directoryとのメタファ  \\
+target VAL        &cd  &targetを変える，cdとのメタファ  \\
   &  \\
 move [FILE]       &mv  &move file  \\
 remove [FILE]     &rm  &remove files  \\
 add               &  &add sources info  \\
 checkdb           &  &check database file  \\
-datebase FILE     &  &read datebase file  \\
-display FILE      &  &display converted hikifile  \\
+datebase FILE     &db  &read datebase file  \\
+display FILE      &show  &display converted hikifile  \\
 euc FILE          &  &translate file to euc  \\
-help [COMMAND]    &  &Describe available commands or one specific command  \\
-version           &  &show program version  \\
+help [COMMAND]    &-h  &Describe available commands  \\
+version           &-v  &show program version  \\
 \hline
 \end{tabular}
 \label{default}

data/hikiutils_yamane/latex_dir/compare.aux

@@ -1,9 +1,15 @@
 \relax 
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}optparseとthorの比較}{7}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.1}optparse}{7}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.2}Thor}{7}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}optparseとthorの比較}{8}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.1}optparse}{8}}
+\@writefile{toc}{\contentsline {paragraph}{runメソッド}{9}}
+\@writefile{toc}{\contentsline {paragraph}{initializeメソッド}{9}}
+\@writefile{toc}{\contentsline {paragraph}{executeメソッド}{9}}
+\@writefile{toc}{\contentsline {paragraph}{fizzbuzzメソッド}{10}}
+\@writefile{toc}{\contentsline {paragraph}{versionメソッド}{10}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.2}Thor}{10}}
+\@writefile{toc}{\contentsline {paragraph}{fizzbuzzメソッド，versionメソッド}{10}}
 \@setckpt{compare}{
-\setcounter{page}{9}
+\setcounter{page}{11}
 \setcounter{equation}{0}
 \setcounter{enumi}{2}
 \setcounter{enumii}{0}
@@ -19,6 +25,6 @@
 \setcounter{subparagraph}{0}
 \setcounter{figure}{1}
 \setcounter{table}{0}
-\setcounter{lstnumber}{1}
+\setcounter{lstnumber}{16}
 \setcounter{lstlisting}{0}
 }

data/hikiutils_yamane/latex_dir/compare.tex

@@ -1,9 +1,11 @@
 
 \subsection{optparseとthorの比較}
-ここでは，FizzBuzzという単純なコードを例にoptparseとCLIのコードの比較を行う．
+今回の既存システムであるhikiutilsはoptparseというコマンドライン解析ライブラリが用いられている．
+本研究ではこの代替ライブラリとしてThorの採用を検討した．
+本章の最初では，FizzBuzzという簡単なコードを例にoptparseとThorにより作成するコマンドライン解析コードの比較を行う．
 
 \subsubsection{optparse}
-optparseとは，getoptよりも簡便で，柔軟性に富み，かつ強力なコマンドライン解析ライブラリである．optparseでは，より宣言的なスタイルのコマンドライン解析手法，すなわちOptionParserのインスタンスでコマンドラインを解析するという手法をとっている．これを使うと，GNU/POSIX構文でオプションを指定できるだけでなく，使用法やヘルプメッセージの生成も行える[1-3]．利用頻度はあまり高くないが古くから開発され，使用例が広く紹介されている．
+optparseとは，getoptよりも簡便で，柔軟性に富み，かつ強力なコマンドライン解析ライブラリである．optparseでは，より宣言的なスタイルのコマンドライン解析手法，すなわちOptionParserのインスタンスでコマンドラインを解析するという手法をとっている．これを使うと，GNU/POSIX構文でオプションを指定できるだけでなく，使用法やヘルプメッセージの生成も行える[2]．利用頻度はあまり高くないが古くから開発され，使用例が広く紹介されている．
 
 optparseの基本的な流れとしては
 
@@ -14,10 +16,75 @@ optparseの基本的な流れとしては
 \end{enumerate}
 である.
 
-OptionParserはコマンドラインのオプション取り扱うためのクラスであるためオブジェクトoptを生成されopt.onにコマンドを登録することができる．しかし，OptionParser\#onにはコマンドが登録されているだけであるため，OptionParser\#parseが呼ばれた時，コマンドラインにオプションが指定されていれば実行される．optparseにはデフォルトとして--helpと--versionオプションを認識する[1-4].
+OptionParserはコマンドラインのオプション取り扱うためのクラスであるためオブジェクトoptを生成されopt.onにコマンドを登録することができる．しかし，OptionParser\#onにはコマンドが登録されているだけであるため，OptionParser\#parseが呼ばれた時，コマンドラインにオプションが指定されていれば実行される．optparseにはデフォルトとして--helpと--versionオプションを認識する[3].
+
+以下に示したコードがoptparseで記述されたfizzbuzzである．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+module Fizzbuzz
+  class Command
+
+     def self.run(argv)
+       new(argv).execute
+     end
+
+     def initialize(argv)
+       @argv = argv
+     end
+
+     def execute
+       options = Options.parse!(@argv)
+       sub_command = options.delete(:command)
+       case sub_command
+            when 'fizzbuzz'
+              fizzbuzz(options[:id])
+            when 'version'
+              version
+            end
+     end
+
+     def fizzbuzz(limit_number)
+       (0..limit_number).map do |num|
+         if (num % 15).zero? then print 'FizzBuzz'
+         elsif (num % 5).zero? then print 'Buzz'
+         elsif (num % 3).zero? then print 'Fizz'
+         else print num.to_s
+         end
+         print ' '
+       end
+     end
+
+     def version
+       puts Fizzbuzz::VERSION
+       exit
+     end
+  end
+end
+\end{lstlisting}
+このコードはfizzbuzzとversionのコマンドを実行させる．
+
+\paragraph{runメソッド}
+コマンド実行を行うためのメソッドであり，argv配列を代入することでexecuteメソッドを実行する．
+
+\paragraph{initializeメソッド}
+初期化を行うメソッドである．
+\begin{quote}\begin{verbatim}
+@argv = argv
+\end{verbatim}\end{quote}
+こうすることでargvをクラス内で利用できるようにする．
+
+\paragraph{executeメソッド}
+上記でoptparseではopt.onにコマンドを登録する必要があると説明したが，opt.onで登録できるものはハイフンがついたコマンドだけであり，ハイフンなしのコマンドの登録はこのようになる．
+
+argv配列の解析を行うOptions.parse!(@argv)をoptionsに代入して解析を行いsub\_commandに代入する．sub\_commandがfizzbuzzであればfizzbuzz(options[:id])メソッドを実行，versionであればversionメソッドを実行する．
+
+\paragraph{fizzbuzzメソッド}
+引数としてlimit\_numberを受け取り，0〜limit\_numberまでの数字を繰り返す．numが15であればFizzbuzzを表示，5であればBuzzを表示，3であればFizzを表示，それ以外は数字を表示し，その後に空白を表示する．
+
+\paragraph{versionメソッド}
+fizzbuzzのバージョンを表示する．
 
 \subsubsection{Thor}
-Thorとは，コマンドラインツールの作成を支援するライブラリのことである．gitやbundlerのようにサブコマンドを含むコマンドラインツールを簡単に作成することができる[1-2]．
+Thorとは，コマンドラインツールの作成を支援するライブラリのことである．gitやbundlerのようにサブコマンドを含むコマンドラインツールを簡単に作成することができる[4]．
 
 Thorの基本的な流れとしては
 
@@ -25,7 +92,32 @@ Thorの基本的な流れとしては
 \item Thorを継承したクラスのパブリックメソッドがコマンドになる
 \item クラス.start(ARGV)でコマンドラインの処理をスタートする
 \end{enumerate}
-である[1-2].
+である[4].
 
 startに渡す引数が空の場合，Thorはクラスのヘルプリストを出力する．また，Thorはサブコマンドやサブサブコマンドも容易に作ることができる．
 
+以下に示したコードがThorで記述されたfizzbuzzである．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+module Fizzbuzz                                                   
+  class CLI < Thor
+
+    desc 'fizzbuzz', 'Get fizzbuzz result from limit number'
+    def fizzbuzz(limit)
+      print Fizzbuzz.fizzbuzz(limit).join(',')
+      exit
+    end
+
+    desc 'version', 'version'
+    def version
+      puts Fizzbuzz::VERSION
+    end
+  end
+end
+\end{lstlisting}
+このコードもoptparseのfizzbuzzと同様fizzbuzzとversionのコマンドを実行させる．
+
+\paragraph{fizzbuzzメソッド，versionメソッド}
+descでコマンド一覧で表示させるコマンド名と説明を書く．
+
+メソッド内ではそれぞれのコマンドの処理内容が書かれている．
+

data/hikiutils_yamane/latex_dir/hikiutils_yamane.aux

@@ -1,10 +1,13 @@
 \relax 
 \@input{abstract.aux}
 \@input{introduction.aux}
-\@writefile{toc}{\contentsline {section}{\numberline {3}方法}{6}}
+\@writefile{toc}{\contentsline {section}{\numberline {3}方法}{7}}
 \@input{compare.aux}
 \@input{optparse.aux}
-\@writefile{toc}{\contentsline {section}{\numberline {4}結果}{13}}
+\@writefile{toc}{\contentsline {section}{\numberline {4}結果}{15}}
 \@input{command.aux}
 \@input{thor.aux}
-\@writefile{toc}{\contentsline {section}{\numberline {5}参考文献}{23}}
+\bibcite{1-1}{1}
+\bibcite{1-2}{2}
+\bibcite{1-3}{3}
+\bibcite{1-4}{4}