hikiutils 0.2.3.4 → 0.2.3.6

data/hikiutils_yamane/latex_dir/hikiutils_yamane.tex

@@ -38,11 +38,25 @@
 }
 \begin{document}
 \title{卒業論文\\
-\vspace{4cm} hikiutilsを用いた\\卒業論文作成}
-\author{ 関西学院大学　理工学部　情報科学科\\\\1234 西谷滋人}
+\vspace{4cm} コマンドラインツール作成ライブラリThorによる\\hikiutilsの書き換え}
+\author{ 関西学院大学　理工学部　情報科学科\\\\27013554 山根亮太}
 \date{\vspace{3cm} 2017年  3月\\
 \vspace{3cm} 指導教員　　西谷　滋人　教授}
 \maketitle
 \tableofcontents
 
+\title{コマンドラインツール作成ライブラリThorによるhikiutilsの書き換え}
+\author{関西学院大学理工学部情報科学科 27013554 山根亮太}
+\date{}
+\maketitle
+\tableofcontents
+\include{abstract}
+\include{introduction}
+\include{results}
+[1] 「hiki」,hikiwiki.org/ja/about.html ,2017/1/30 アクセス.\verb|{{br}}|
+[2] 「hikiutils」,\verb|https://rubygems.org/gems/hikiutils| ,2017/1/30 アクセス.\verb|{{br}}|
+[3] 「The Ruby Toolbox」, CLI Option Parsers,\verb|https://www.ruby-toolbox.com/categories/CLI_Option_Parsers| ,2017/1/30 アクセス.\verb|{{br}}|
+[4] 「Thorの使い方まとめ」, \verb|http://qiita.com/succi0303/items/32560103190436c9435b| ,2017/1/30 アクセス.\verb|{{br}}|
+[5] 「15.5. optparse - コマンドラインオプション解析器」, \verb|http://docs.python.jp/2/library/optparse.html| ,2017/1/30 アクセス.\verb|{{br}}|
+[6] 「library optparse」, \verb|https://docs.ruby-lang.org/ja/latest/library/optparse.html| ,2017/1/30 アクセス.\verb|{{br}}|
 \end{document}

data/hikiutils_yamane/latex_dir/hikiutils_yamane.toc

@@ -0,0 +1,20 @@
+\contentsline {section}{\numberline {1}概要}{3}
+\contentsline {section}{\numberline {2}序論}{4}
+\contentsline {subsection}{\numberline {2.1}目的}{4}
+\contentsline {subsection}{\numberline {2.2}既存システムの背景}{4}
+\contentsline {subsubsection}{\numberline {2.2.1}hiki}{4}
+\contentsline {subsubsection}{\numberline {2.2.2}hikiutils}{4}
+\contentsline {section}{\numberline {3}結果}{6}
+\contentsline {subsection}{\numberline {3.1}開発の結果}{6}
+\contentsline {subsection}{\numberline {3.2}thorとoptparseのコードの比較}{7}
+\contentsline {subsubsection}{\numberline {3.2.1}Thorとは}{7}
+\contentsline {paragraph}{Thorの基本的な流れ}{7}
+\contentsline {subsubsection}{\numberline {3.2.2}optparseとは}{7}
+\contentsline {paragraph}{optparseの基本的な流れ}{7}
+\contentsline {subsubsection}{\numberline {3.2.3}コードの解説}{7}
+\contentsline {paragraph}{Thorの定義}{7}
+\contentsline {paragraph}{実際のコード}{8}
+\contentsline {paragraph}{hikiutilsの実行}{9}
+\contentsline {paragraph}{実際のコード}{10}
+\contentsline {paragraph}{コマンドの表示と実行}{13}
+\contentsline {paragraph}{実際のコード}{14}

data/hikiutils_yamane/latex_dir/introduction.aux

@@ -0,0 +1,26 @@
+\relax 
+\@writefile{toc}{\contentsline {section}{\numberline {2}序論}{4}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}目的}{4}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}既存システムの背景}{4}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.1}hiki}{4}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.2}hikiutils}{4}}
+\@setckpt{introduction}{
+\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}{2}
+\setcounter{subsubsection}{2}
+\setcounter{paragraph}{0}
+\setcounter{subparagraph}{0}
+\setcounter{figure}{0}
+\setcounter{table}{0}
+\setcounter{lstnumber}{1}
+\setcounter{lstlisting}{0}
+}

data/hikiutils_yamane/latex_dir/introduction.tex

@@ -0,0 +1,33 @@
+\section{序論}
+\subsection{目的}
+本研究ではhikiの編集作業をより容易にするためのツールの開発を行った． 
+hikiは通常web上で編集を行っているが,GUIとCUIが混在しており,操作に不便な点がある. 
+そこで,編集操作が CUI で完結するために開発をされたのが hikiutils である. 
+しかし,そのユーザインタフェースにはコマンドが直感的でないという問題点がある. 
+そこで，Thorというコマンドラインツール作成ライブラリを用いる．
+optparseというコマンドライン解析ライブラリを使用しているhikiutilsを新たなコマンドライン解析ライブラリを使用することコマンドを書き換え，より直感的なコマンドにすることが可能である．
+
+\subsection{既存システムの背景}
+\subsubsection{hiki}
+hikiとはプログラミング言語Rubyを用いられることで作られたwikiクローンの１つである．
+hikiの主な特徴として
+
+\begin{itemize}
+\item オリジナルwikiに似たシンプルな書式
+\item プラグインによる機能拡張
+\item 出力するHTMLを柔軟に変更可能
+\item ページにカテゴリ付けできる
+\item CSSを使ったテーマ機能
+\item 携帯端末可能
+\item InterWikiのサポート
+\item HikiFarmに対応
+\item ページの追加，編集がしやすい
+\end{itemize}
+等がある[1].
+
+\subsubsection{hikiutils}
+hikiutils は hiki の編集作業を容易に行うことができるよう にするツール群であり,プログラミング言語 Ruby のライブ ラリである gem フォーマットに従って提供されている[2]. 
+hikiutils は CLI(Command Line Interface) で操作するため, オプション解析をおこなう必要がある. 
+gem には,この用途 に適合したライブラリがいくつも提供されている[3]. 
+この中 で,あまり利用頻度は高くないが古くから開発され,使用例 が広く紹介されている optparse を利用している.
+

data/hikiutils_yamane/latex_dir/results.aux

@@ -0,0 +1,45 @@
+\relax 
+\@writefile{toc}{\contentsline {section}{\numberline {3}結果}{6}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}開発の結果}{6}}
+\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces }}{6}}
+\newlabel{default}{{1}{6}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}thorとoptparseのコードの比較}{7}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.1}Thorとは}{7}}
+\@writefile{toc}{\contentsline {paragraph}{Thorの基本的な流れ}{7}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.2}optparseとは}{7}}
+\@writefile{toc}{\contentsline {paragraph}{optparseの基本的な流れ}{7}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3}コードの解説}{7}}
+\@writefile{toc}{\contentsline {paragraph}{Thorの定義}{7}}
+\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces }}{8}}
+\newlabel{default}{{1}{8}}
+\@writefile{toc}{\contentsline {paragraph}{実際のコード}{8}}
+\@writefile{toc}{\contentsline {paragraph}{hikiutilsの実行}{9}}
+\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces }}{9}}
+\newlabel{default}{{2}{9}}
+\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces }}{10}}
+\newlabel{default}{{3}{10}}
+\@writefile{toc}{\contentsline {paragraph}{実際のコード}{10}}
+\@writefile{toc}{\contentsline {paragraph}{コマンドの表示と実行}{13}}
+\@writefile{lof}{\contentsline {figure}{\numberline {4}{\ignorespaces }}{13}}
+\newlabel{default}{{4}{13}}
+\@writefile{toc}{\contentsline {paragraph}{実際のコード}{14}}
+\@setckpt{results}{
+\setcounter{page}{17}
+\setcounter{equation}{0}
+\setcounter{enumi}{3}
+\setcounter{enumii}{0}
+\setcounter{enumiii}{0}
+\setcounter{enumiv}{0}
+\setcounter{footnote}{0}
+\setcounter{mpfootnote}{0}
+\setcounter{part}{0}
+\setcounter{section}{3}
+\setcounter{subsection}{2}
+\setcounter{subsubsection}{3}
+\setcounter{paragraph}{0}
+\setcounter{subparagraph}{0}
+\setcounter{figure}{4}
+\setcounter{table}{1}
+\setcounter{lstnumber}{61}
+\setcounter{lstlisting}{0}
+}

data/hikiutils_yamane/latex_dir/results.tex

@@ -0,0 +1,342 @@
+\section{結果}
+\subsection{開発の結果}
+開発の結果コマンドを以下のように書き換えることができた
+
+\begin{table}[htbp]\begin{center}
+\caption{}
+\begin{tabular}{llll}
+\hline
+変更前  &変更後  &コマンド一覧  \\ \hline
+add               &  &add sources info  \\
+checkdb           &  &check database file  \\
+datebase FILE     &  &read datebase file  \\
+display FILE      &　  &display converted hikifile  \\
+edit FILE         &open  &open file  \\
+euc FILE          &  &translate file to euc  \\
+help [COMMAND]    &  &Describe available commands or one specific command  \\
+list [FILE]       &ls  &list files  \\
+move [FILE]       &mv|  move file  \\
+remove [FILE]     &rm  &remove files  \\
+rsync             &  &rsync files  \\
+show              &  &lsとかぶる．  \\
+target VAL        &cd  &set target id  \\
+update FILE       &touch  &update file  \\
+version           &  &show program version  \\
+\hline
+\end{tabular}
+\label{default}
+\end{center}\end{table}
+%for inserting separate lines, use \hline, \cline{2-3} etc.
+
+hikiutilsのコマンドライン解析ツールをoptparseからthorに換えることでコマンドの書き換えを行うことができた．
+また，プログラムのコードもoptparseよりthorのほうが短く書け，簡単にコマンドを作成することができた．
+
+\subsection{thorとoptparseのコードの比較}
+\subsubsection{Thorとは}
+Thorとは，コマンドラインツールの作成を支援するライブラリのことである．
+gitやbundlerのようにサブコマンドを含むコマンドラインツールを簡単に作成することができる[4]．
+
+\paragraph{Thorの基本的な流れ}
+\begin{enumerate}
+\item Thorを継承したクラスのパブリックメソッドがコマンドになる
+\item クラス.start(ARGV)でコマンドラインの処理をスタートする
+\end{enumerate}
+という流れである[4].
+
+\subsubsection{optparseとは}
+optparseモジュールとは，getoptよりも簡便で，柔軟性に富み，かつ強力なコマンドライン解析ライブラリである．
+optparseでは，より宣言的なスタイルのコマンドライン解析手法，すなわちOptionParserのインスタンスでコマンドラインを解析するという手法をとっている．
+これを使うと，GNU/POSIX構文でオプションを指定できるだけでなく，使用法やヘルプメッセージの生成も行える[5]．
+
+\paragraph{optparseの基本的な流れ}
+\begin{enumerate}
+\item OptionParserオブジェクトoptを生成する
+\item オプションを取り扱うブロックをoptに登録する
+\item opt.parse(ARGV)でコマンドラインを実際にparseする
+\end{enumerate}
+という流れである[6].
+
+\subsubsection{コードの解説}
+\paragraph{Thorの定義}
+\begin{figure}[htbp]\begin{center}
+\includegraphics[width=6cm,bb=0 0 442 500]{../figs/./hikiutils_yamane.003.jpg}
+\caption{}
+\label{default}\end{center}\end{figure}
+\begin{enumerate}
+\item Hikithor::CLI.start(ARGV)が呼ばれる
+\item initializeメソッドが呼ばれる
+\item これではThorのinitializeメソッドが呼ばれない
+\item superを書くことでThorのinitializeメソッドが呼ばれる
+\end{enumerate}
+optparseではrequireでoptparseを呼ぶだけでいいが，ThorではrequireでThorを呼びCLIクラスで継承しinitializeメソッドにsuperを書くことでThorのinitializeを呼ぶ必要がある．
+
+\paragraph{実際のコード}\begin{lstlisting}[style=customRuby]
+# -*- 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
+\end{lstlisting}
+\paragraph{hikiutilsの実行}
+\begin{itemize}
+\item Thor
+\end{itemize}
+\begin{figure}[htbp]\begin{center}
+\includegraphics[width=6cm,bb=0 0 442 500]{../figs/./hikiutils_yamane.004.jpg}
+\caption{}
+\label{default}\end{center}\end{figure}
+\begin{enumerate}
+\item hiki\_thorのHikithor::CLI.start(ARGV)でhikiutils\_thor.rbのCLIクラスを呼ぶ\verb|{{br}}|
+\item hikiutils\_thor.rbのCLIクラスのメソッドを順に実行していく\verb|{{br}}|
+\end{enumerate}
+\begin{itemize}
+\item optparse
+\end{itemize}
+\begin{figure}[htbp]\begin{center}
+\includegraphics[width=6cm,bb=0 0 442 500]{../figs/./hikiutils_yamane.001.jpg}
+\caption{}
+\label{default}\end{center}\end{figure}
+\begin{enumerate}
+\item HikiのHikiUtils::Command.run(ARGV)でhikiutils.rbのrunメソッドを呼ぶ
+\item new(argv).executeでexecuteメソッドが実行される
+\end{enumerate}
+このようにoptparseでは実行を行うためのメソッドが必要であるが，Thorではクラスのメソッドを順に実行していくため
+runメソッドとexecuteメソッドは必要ない．
+
+\paragraph{実際のコード}
+\begin{itemize}
+\item Thor
+\end{itemize}\begin{lstlisting}[style=customRuby]
+#!/usr/bin/env ruby                                                             
+
+require "hikiutils_thor"
+
+Hikithor::CLI.start(ARGV)
+\end{lstlisting}\begin{lstlisting}[style=customRuby]
+# -*- 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
+
+\end{lstlisting}
+\begin{itemize}
+\item optparse
+\end{itemize}\begin{lstlisting}[style=customRuby]
+#!/usr/bin/env ruby                                                             
+
+require "hikiutils"
+
+HikiUtils::Command.run(ARGV)
+\end{lstlisting}\begin{lstlisting}[style=customRuby]
+    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  
+\end{lstlisting}
+\paragraph{コマンドの表示と実行}
+\begin{itemize}
+\item Thor
+\end{itemize}
+\begin{figure}[htbp]\begin{center}
+\includegraphics[width=6cm,bb=0 0 442 500]{../figs/./hikiutils_yamane.002.jpg}
+\caption{}
+\label{default}\end{center}\end{figure}
+\begin{enumerate}
+\item コマンド名，コマンドの説明を一覧に表示させる
+\item パブリックメソッドのコマンドを別のコマンド名でも実行できるようにする
+\item コマンドの命令の実行コード
+\end{enumerate}
+\begin{itemize}
+\item optparse
+\end{itemize}
+\verb|{{attach_view(hikiutils_yamane.005.jpg)}}|
+よって，optparseではOptionParserオブジェクトoptを生成を行い，コマンドをoptに登録して一覧に表示するメソッドとそれぞれコマンドの実行処理が書かれたメソッドがあるが，
+thorではそれぞれのdescで一覧を表示しmapとパブリックメソッドでコマンドの実行処理を行うためコードが短くなる．
+
+\paragraph{実際のコード}
+\begin{itemize}
+\item Thor
+\end{itemize}\begin{lstlisting}[style=customRuby]
+    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
+\end{lstlisting}
+\begin{itemize}
+\item optparse
+\end{itemize}\begin{lstlisting}[style=customRuby]
+    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
+\end{lstlisting}