hikiutils 0.2.3.13 → 0.2.3.14

data/hikiutils_yamane/optparse.hiki

@@ -1,114 +0,0 @@
-{{toc}}
-!既存のhikiutilsのコマンド解説
-既存のhikiutilsはコマンド解析ライブラリのoptparseを用いて，コマンドの処理を行っている．
-optparseの特徴は，「コマンドの登録，実行method」に分けて記述することが期待されている．
-また，CLIの起動の仕方が特徴的である．この二つを取り出して，動作とコードを説明する．
-
-!!コマンドの登録と実行メソッド
-
-!!!caption:(fig:005)コマンドの登録と実行メソッドの対応．
-{{attach_view(hikiutils_yamane.005.jpg,hikiutils_yamane)}}
-
-optparseでは以下の通り，コマンドの登録と実行が行われる．
-#OptionParserオブジェクトoptを生成
-#optにコマンドを登録
-#入力されたコマンドの処理のメソッドへ移動
-optparseではOptionParserオブジェクトoptの生成を行い，コマンドをoptに登録することでコマンドを作成することができる．しかし，これはコマンドを登録しているだけでコマンドの一覧ではこれを表示することができるが，コマンドの実行を行うためには実行を行うためのメソッドを作成する必要がある．optparseでのコマンドの実行はoptで登録されたコマンドが入力されることでそれぞれのコマンドの処理を行うメソッドに移動し処理を行う．しかし，このコマンド登録はハイフンを付けたコマンドしか登録ができず，ハイフンなしのコマンド登録はまた別の手段でやらなくてはいけない．
-
-<<< 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) }
-
-        ...省略...
-
-      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])
-
-      ...省略...
-
-    end
-
-    以下略
-
->>>
-
-!!CLIの実行プロセス
-!!!caption:(fig:007)CLIの実行プロセス．
-{{attach_view(hikiutils_yamane.007.jpg,hikiutils_yamane)}}
-
-optparseを用いた場合のCLIの実行プロセスは次の通りとなる．
-#HikiのHikiUtils::Command.run(ARGV)でhikiutils.rbのrunメソッドを呼ぶ
-#new(argv).executeでexecuteメソッドが実行される
-
-optparseではHikiutils::Command.run(ARGV)を実行される．requireで呼び出されたhikiutils.rbでrunメソッドが実行される．そこでコマンドを登録しているexecuteメソッドへ移動し入力したコマンドと対応させる．そして，対応したコマンドの処理が行われるメソッドに移動することで実行される．このようにoptparseでは実行を行うためのメソッドが必要であるが，
-!!コード
-
-optparseの呼び出し側のexe/hikiのコードは次の通りである．
-<<< ruby
-#!/usr/bin/env ruby                                                             
-
-require "hikiutils"
-
-HikiUtils::Command.run(ARGV)
->>>
-
-また呼び出される側のlib/hikiutils.rbのrunおよびexecute部のコードは次の通りとなる．
-<<< 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  
->>>

data/hikiutils_yamane/thor.hiki

@@ -1,107 +0,0 @@
-!Thorによる実装
-手法のところで概観した通り，thorを用いることで記述の簡略化が期待できる．ここでは，実際に書き換える前後，すなわちoptparse版とthor版の対応するコードを比較することで，以下の具体的な違い
-*クラス初期化 
-*コマンド定義
-*CLIの実行プロセス
-について詳しく検討を行う．
-
-!!クラス初期化
-!!!caption:Thorのinitializeでのコード
-{{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
-
-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)
-
-      ...以下略...
-   end
->>>
-
-!!コマンド定義
-
-!!!caption:thorにおけるコマンド記述のひな形．
-{{attach_view(hikiutils_yamane.004.jpg,hikiutils_yamane)}}
-
-thorではoptparseのような登録処理はない．図にある通りにコマンドが記述され，それらは以下のように構成される．
-#desc以降にコマンド名と，その説明が記述される．これらはコマンドhelpで一覧として表示させる
-#mapによって別のコマンド名でも実行できるように定義される．
-#defで定義されたメソッドの実行コード
-
-Thorではdescで一覧を表示されるコマンド名，コマンドの説明を登録する．しかし，ここで記述したコマンドは単に一覧で表示させるためのものであり，実際に実行される時に呼び出すコマンド名は，defで定義された名前である．Thorでは処理実行を行うメソッド名がコマンド名となり，コマンド名１つが対応する．
-
-これに別名を与えるために利用されるキーワードがmapである．
-<<<
-map A => B
->>>
-mapとはBと呼ばれるメソッドをAでも呼べるようにしてくれるものである．
-よって，これを使うことでコマンドの別名を指定することができる．
-
-<<< 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])
-      ,,,以下略...
-    end
->>>
-
-以上より，Thorではコマンドの指定と処理にはdesc,map,処理メソッドだけで済む．optparseではコマンドを登録するためのメソッドと処理メソッドの両方が必要になっていた．一方Thorでは，処理メソッドが直接コマンド名となるため記述が簡潔になる．
-
-!!CLIの実行プロセス
-
-
-!!!caption:CLIの実行プロセス．
-{{attach_view(hikiutils_yamane.006.jpg,hikiutils_yamane)}}
-
-Thorにおけるcliの実行プロセスは次の通りである．
-#hiki_thorのHikithor::CLI.start(ARGV)でhikiutils_thor.rbのCLIクラスを呼ぶ
-#hikiutils_thor.rbのCLIクラスのメソッドを順に実行していく
-
-Thorではstart(ARGV)を呼び出すことでCLIを開始する．Hikithor::CLI.start(ARGV)を実行されることによりrequireで呼ばれているhikiutils_thor.rbのCLIコマンドを順に実行する．そして，入力されたコマンドと一致するメソッドを探し，そのコマンドの処理が実行される．
-
-<<< ruby
-#!/usr/bin/env ruby                                                             
-
-require "hikiutils_thor"
-
-Hikithor::CLI.start(ARGV)
->>>
-
-<<< ruby
-
-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)
-      ...以下略...
->>>
-
-Thorではクラスのメソッドを順に実行していくためrunメソッドとexecuteメソッドは必要ない．また，optparseでの実行手順はメソッドの移動回数が多く複雑であるが，Thorは単純で分かりやすいものとなっている．
-
-!!optparseとの全体的な比較
-コードからもThorのほうが短くなっていることが分かる．よって，Thorとoptparseでのコードの違いは以上の部分になるが全体的にもThorのほうがコードが短くなり，コマンドの定義も簡単に行うことができる．また，実行手順も分かりやすくコードが読みやすいため書き換えもすぐ行うことができるので，より直感的なコマンドを実装することも可能となった．