hikiutils 0.2.3.6 → 0.2.3.7

data/hikiutils_yamane/compare.hiki

@@ -0,0 +1,309 @@
+{{toc}}
+!!thor と optparse のコードの比較
+hikiutilsのコマンドライン解析ツールをoptparseからthorに換えることでコマンドの書き換えを行うことができた．
+また，thorで書かれたhikiutilsはoptparseで書かれたものよりもコードが短くなり，コマンドの解析も簡単に行えることができた．
+ここではthorとoptparseのコードを比較しthorの良さを確認する．
+!!!Thorとoptparseとは
+!!!!Thorとは
+Thorとは，コマンドラインツールの作成を支援するライブラリのことである．
+gitやbundlerのようにサブコマンドを含むコマンドラインツールを簡単に作成することができる[4]．
+
+Thorの基本的な流れとしては
+
+#Thorを継承したクラスのパブリックメソッドがコマンドになる
+#クラス.start(ARGV)でコマンドラインの処理をスタートする
+という流れである[4].
+
+startに渡す引数が空の場合，Thorはクラスのヘルプリストを出力する．
+また，Thorはサブコマンドやサブサブコマンドも作ることができる．
+!!!!optparseとは
+optparseモジュールとは，getoptよりも簡便で，柔軟性に富み，かつ強力なコマンドライン解析ライブラリである．
+optparseでは，より宣言的なスタイルのコマンドライン解析手法，すなわちOptionParserのインスタンスでコマンドラインを解析するという手法をとっている．
+これを使うと，GNU/POSIX構文でオプションを指定できるだけでなく，使用法やヘルプメッセージの生成も行える[5]．
+
+利用頻度はあまり高くないが古くから開発され，使用例が広く紹介されている．
+
+optparseの基本的な流れとしては
+
+#OptionParserオブジェクトoptを生成する
+#オプションを取り扱うブロックをopt.onに登録する
+#opt.parse(ARGV)でコマンドラインを実際にparseする
+という流れである.
+
+OptionParserはコマンドラインのオプション取り扱うためのクラスであるためオブジェクトoptを生成されopt.onにコマンドを登録することができる．
+しかし，OptionParser\#onにはコマンドが登録されているだけであるため，OptionParser\#parseが呼ばれた時，コマンドラインにオプションが指定されていれば実行される．
+optparseにはデフォルトとして--helpと--versionオプションを認識する[6].
+!!!コードの解説
+!!!!Thorの定義                                                      
+{{attach_view(hikiutils_yamane.003.jpg,hikiutils_yamane)}}
+Thorのinitializeの定義のされ方
+#Hikithor::CLI.start(ARGV)が呼ばれる
+#initializeメソッドが呼ばれる
+#これではThorのinitializeメソッドが呼ばれない
+#superを書くことでThorのinitializeメソッドが呼ばれる
+optparseではrequireでoptparseを呼ばれoptparseのinitializeを定義する必要はないが，Thorはinitializeを定義する必要がある．
+Thorの定義方法はrequireでThorを呼びCLIクラスで継承し，initializeメソッドにsuperを書くことでThorのinitializeが呼ばれる．
+initializeメソッド内ではThorの初期設定がされていないため，スーパークラスのメソッドを読み出してくれるsuperを書き加えることで図のようにinitializeメソッドでThorのinitilalizeメソッドが
+呼ばれて定義される．
+!!!!!実際のコード
+<<< 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)}}
+
+#hiki_thorのHikithor::CLI.start(ARGV)でhikiutils_thor.rbのCLIクラスを呼ぶ
+
+#hikiutils_thor.rbのCLIクラスのメソッドを順に実行していく
+
+*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)}}
+#コマンド名，コマンドの説明を一覧に表示させる
+#パブリックメソッドのコマンドを別のコマンド名でも実行できるようにする
+#コマンドの命令の実行コード
+Thorではdescで一覧を表示させるコマンド名，コマンドの説明を登録する．しかし，ここで記述したコマンドは一覧で表示させるものであり，実行されることはないので実際のコマンドと対応させる必要がある．
+Thorでは処理実行を行うメソッドがコマンドとなる．しかし，それではコマンド名は１つしか使うことができない．
+ここで用いるものがmapである．mapを使うことで別のコマンドを指定することができる．
+*optparse
+{{attach_view(hikiutils_yamane.005.jpg,hikiutils_yamane)}}
+#OptionParserオブジェクトoptを生成
+#optにコマンドを登録
+#入力されたコマンドの処理のメソッドへ移動
+optparseではOptionParserオブジェクトoptの生成を行い，コマンドをoptに登録することでコマンドを作成することができる．しかし，これはコマンドを登録しているだけで
+コマンドの一覧ではこれを表示することができるがコマンドの実行を行うためには実行を行うためのメソッドを作成する必要がある．optparseでのコマンドの実行はoptで登録された
+コマンドが入力されることでそれぞれのコマンドの処理を行うメソッドに移動し処理を行う．しかし，このコマンド登録は-を付けたコマンドした登録ができなく，-なしのコマンド登録は
+また別のやり方でやらなくてはいけない．
+以上より，Thorではコマンドの指定と処理にはdesc,map,処理メソッドだけで済むが，optparseではコマンドを登録するためのメソッドと処理メソッドが必要になってくる．
+また，コマンドはThorでは処理メソッドがコマンド名になるが，optparseではコマンドを登録するための処理も必要となってくる．
+
+!!!!!実際のコード
+*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
+>>>
+コードからもThorのほうが短くなっていることが分かる．
+よって，Thorとoptparseでのコードの違いは以上の部分になるが全体的にもThorのほうがコードが短くなり，
+コマンドの定義も簡単に行うことができる．また，コマンドを簡単に定義できることで書き換えもすぐ行うことが
+できるので，より直感的なコマンドに実装することも可能となった．

data/hikiutils_yamane/hikiutils_yamane.hiki

@@ -2,36 +2,28 @@
 !title:コマンドラインツール作成ライブラリThorによるhikiutilsの書き換え
 !author:関西学院大学理工学部情報科学科 27013554 山根亮太
 
-![[hikiutils_yamane_abstract]]
+![[概要|hikiutils_yamane_abstract]]
+!序論
 ![[hikiutils_yamane_introduction]]
+!![[hikiutils_yamane_purpose]]
 !方法
-!序論
-!!目的
-!!既存システムの説明
-図に従ってhiki systemの動作概要を説明する．
-
-!!!caption:hiki web systemとhiki systemの対応関係．
-{{attach_view(hikiutils_yamane.006.jpeg,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のコマンドオプションの実装をしなおして，より使いやすくすることが本研究の目的です．
-
-![[hikiutils_yamane_results]]
 !結果
-!!thor と optparse のコードの比較
+!![[hikiutils_yamane_results]]
+!![[hikiutils_yamane_compare]]
+!!![[hikiutils_yamane_clidescription]]
+!!![[hikiutils_yamane_code]]
 
 !参考文献
 [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 アクセス.
-# 「Thorの使い方まとめ」, http://qiita.com/succi0303/items/32560103190436c9435b ,2017/1/30 アクセス.
-# 「15.5. optparse - コマンドラインオプション解析器」, http://docs.python.jp/2/library/optparse.html ,2017/1/30 アクセス.
-# 「library optparse」, https://docs.ruby-lang.org/ja/latest/library/optparse.html ,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 アクセス.