my_help 0.4.5 → 0.5.0

data/docs/yagi/comparisons/.ipynb_checkpoints/Untitled-checkpoint.ipynb

@@ -0,0 +1,6 @@
+{
+ "cells": [],
+ "metadata": {},
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/docs/yagi/comparisons/.ipynb_checkpoints/comp-checkpoint.ipynb

@@ -0,0 +1,230 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "toc": "true"
+   },
+   "source": [
+    "# Table of Contents\n",
+    " <p><div class=\"lev1 toc-item\"><a href=\"#repl\" data-toc-modified-id=\"repl-1\"><span class=\"toc-item-num\">1&nbsp;&nbsp;</span>repl</a></div><div class=\"lev1 toc-item\"><a href=\"#比較\" data-toc-modified-id=\"比較-2\"><span class=\"toc-item-num\">2&nbsp;&nbsp;</span>比較</a></div>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# repl\n",
+    "read execute print loop\n",
+    "\n",
+    "```ruby\n",
+    "require 'optparse'\n",
+    "\n",
+    "opt = OptionParser.new\n",
+    "opt.on('-a', '--add', 'add an item') { puts 'Added' }\n",
+    "opt.on('-d', '--del', 'delete an item') { puts 'Deleted' }\n",
+    "opt.parse(ARGV)\n",
+    "```\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": [
+    "#!/usr/bin/ruby                                                                                                 \n",
+    "require 'optparse'\n",
+    "\n",
+    "options = {:name => nil}\n",
+    "\n",
+    "parser = OptionParser.new do|opts|\n",
+    "  opts.on('-n', '--name name', 'Give your own name') do |name|\n",
+    "    options[:name] = name;\n",
+    "    end\n",
+    "\n",
+    "  opts.on('-h', '--help', 'Displays Help') do\n",
+    "    puts opts\n",
+    "    exit\n",
+    "    end\n",
+    "end\n",
+    "\n",
+    "parser.parse!\n",
+    "\n",
+    "sayHello = 'Hello ' + options[:name]\n",
+    "\n",
+    "puts sayHello"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Could not find command \"kernel\".\n"
+     ]
+    }
+   ],
+   "source": [
+    "require 'thor'\n",
+    "\n",
+    "class MyCLI < Thor\n",
+    "  desc \"hello NAME\", \"say hello to NAME\"\n",
+    "  def hello(name)\n",
+    "    puts \"Hello #{name}\"\n",
+    "  end\n",
+    "end\n",
+    "\n",
+    "\n",
+    "MyCLI.start(ARGV)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "ename": "LoadError",
+     "evalue": "cannot load such file -- hanami/cli",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[31mLoadError\u001b[0m: cannot load such file -- hanami/cli",
+      "\u001b[37m/usr/local/lib/ruby/site_ruby/2.2.0/rubygems/core_ext/kernel_require.rb:55:in `require'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/site_ruby/2.2.0/rubygems/core_ext/kernel_require.rb:55:in `require'\u001b[0m",
+      "\u001b[37m(pry):28:in `<main>'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:355:in `eval'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:355:in `evaluate_ruby'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:323:in `handle_line'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:243:in `block (2 levels) in eval'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:242:in `catch'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:242:in `block in eval'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:241:in `catch'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/pry-0.11.2/lib/pry/pry_instance.rb:241:in `eval'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/lib/iruby/backend.rb:66:in `eval'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/lib/iruby/backend.rb:12:in `eval'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/lib/iruby/kernel.rb:87:in `execute_request'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/lib/iruby/kernel.rb:47:in `dispatch'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/lib/iruby/kernel.rb:37:in `run'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/lib/iruby/command.rb:70:in `run_kernel'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/lib/iruby/command.rb:34:in `run'\u001b[0m",
+      "\u001b[37m/usr/local/lib/ruby/gems/2.2.0/gems/iruby-0.3/bin/iruby:5:in `<top (required)>'\u001b[0m",
+      "\u001b[37m/usr/local/bin/iruby:23:in `load'\u001b[0m",
+      "\u001b[37m/usr/local/bin/iruby:23:in `<main>'\u001b[0m"
+     ]
+    }
+   ],
+   "source": [
+    "#!/usr/bin/env ruby                                                                                             \n",
+    "require \"bundler/setup\"\n",
+    "require 'hanami/cli'\n",
+    "\n",
+    "module Foo\n",
+    "  module CLI\n",
+    "    module Commands\n",
+    "      extend Hanami::CLI::Registry\n",
+    "\n",
+    "      class Greet < Hanami::CLI::Command\n",
+    "\targument :name, required: true, desc: \"The name of the person to greet\"\n",
+    "\n",
+    "\tdef call(name:, **)\n",
+    "          result = \"Hello #{name}\"\n",
+    "\n",
+    "          puts result\n",
+    "\tend\n",
+    "      end\n",
+    "\n",
+    "      register \"hello\", Greet\n",
+    "    end\n",
+    "  end\n",
+    "end\n",
+    "\n",
+    "Hanami::CLI.new(Foo::CLI::Commands).call"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 比較\n",
+    ".コード量においてはthorが最も少なく簡潔で分かりやすい．\n",
+    "\n",
+    ".optparse及びhanamiではヘルプを自作する必要があるが，thorではその必要がなくruby thor.rbとだけ入力するとヘルプを表示する．\n",
+    "\n",
+    ".ruby optparse.rbと入力するとエラーが表示されるが，ruby hanami.rbでは使用可能なコマンドの一覧が表示される．\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 2.2.2",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "2.2.2"
+  },
+  "latex_envs": {
+   "LaTeX_envs_menu_present": true,
+   "autocomplete": true,
+   "bibliofile": "biblio.bib",
+   "cite_by": "apalike",
+   "current_citInitial": 1,
+   "eqLabelWithNumbers": true,
+   "eqNumInitial": 1,
+   "hotkeys": {
+    "equation": "Ctrl-E",
+    "itemize": "Ctrl-I"
+   },
+   "labels_anchors": false,
+   "latex_user_defs": false,
+   "report_style_numbering": false,
+   "user_envs_cfg": false
+  },
+  "toc": {
+   "colors": {
+    "hover_highlight": "#DAA520",
+    "navigate_num": "#000000",
+    "navigate_text": "#333333",
+    "running_highlight": "#FF0000",
+    "selected_highlight": "#FFD700",
+    "sidebar_border": "#EEEEEE",
+    "wrapper_background": "#FFFFFF"
+   },
+   "moveMenuLeft": true,
+   "nav_menu": {
+    "height": "47px",
+    "width": "252px"
+   },
+   "navigate_menu": true,
+   "number_sections": true,
+   "sideBar": true,
+   "threshold": 4,
+   "toc_cell": true,
+   "toc_section_display": "block",
+   "toc_window_display": true,
+   "widenNotebook": false
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/docs/yagi/comparisons/comp.ipynb

@@ -0,0 +1,178 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# repl\n",
+    "read execute print loop\n",
+    "\n",
+    "```ruby\n",
+    "require 'optparse'\n",
+    "\n",
+    "opt = OptionParser.new\n",
+    "opt.on('-a', '--add', 'add an item') { puts 'Added' }\n",
+    "opt.on('-d', '--del', 'delete an item') { puts 'Deleted' }\n",
+    "opt.parse(ARGV)\n",
+    "```\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#!/usr/bin/ruby                                                                                                 \n",
+    "require 'optparse'\n",
+    "\n",
+    "options = {:name => nil}\n",
+    "\n",
+    "parser = OptionParser.new do|opts|\n",
+    "  opts.on('-n', '--name name', 'Give your own name') do |name|\n",
+    "    options[:name] = name;\n",
+    "    end\n",
+    "\n",
+    "  opts.on('-h', '--help', 'Displays Help') do\n",
+    "    puts opts\n",
+    "    exit\n",
+    "    end\n",
+    "end\n",
+    "\n",
+    "parser.parse!\n",
+    "\n",
+    "sayHello = 'Hello ' + options[:name]\n",
+    "\n",
+    "puts sayHello"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Could not find command \"kernel\".\n"
+     ]
+    }
+   ],
+   "source": [
+    "require 'thor'\n",
+    "\n",
+    "class MyCLI < Thor\n",
+    "  desc \"hello NAME\", \"say hello to NAME\"\n",
+    "  def hello(name)\n",
+    "    puts \"Hello #{name}\"\n",
+    "  end\n",
+    "end\n",
+    "\n",
+    "\n",
+    "MyCLI.start(ARGV)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "ename": "NameError",
+     "evalue": "uninitialized constant Hanami::CLI\nDid you mean?  Hanami::Cli\n               Hanami::CliBase\n               Hanami::CliSubCommands\n               CGI",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[31mNameError\u001b[0m: uninitialized constant Hanami::CLI\nDid you mean?  Hanami::Cli\n               Hanami::CliBase\n               Hanami::CliSubCommands\n               CGI",
+      "\u001b[37m<main>:7:in `<module:Commands>'\u001b[0m",
+      "\u001b[37m<main>:6:in `<module:CLI>'\u001b[0m",
+      "\u001b[37m<main>:5:in `<module:Foo>'\u001b[0m",
+      "\u001b[37m<main>:4:in `<main>'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/backend.rb:44:in `eval'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/backend.rb:44:in `eval'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/backend.rb:12:in `eval'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/kernel.rb:87:in `execute_request'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/kernel.rb:47:in `dispatch'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/kernel.rb:37:in `run'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/command.rb:70:in `run_kernel'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/lib/iruby/command.rb:34:in `run'\u001b[0m",
+      "\u001b[37m/Library/Ruby/Gems/2.3.0/gems/iruby-0.3/bin/iruby:5:in `<top (required)>'\u001b[0m",
+      "\u001b[37m/usr/local/bin/iruby:22:in `load'\u001b[0m",
+      "\u001b[37m/usr/local/bin/iruby:22:in `<main>'\u001b[0m"
+     ]
+    }
+   ],
+   "source": [
+    "#!/usr/bin/env ruby                                                                                             \n",
+    "require \"bundler/setup\"\n",
+    "require \"hanami/cli\"\n",
+    "\n",
+    "module Foo\n",
+    "  module CLI\n",
+    "    module Commands\n",
+    "      extend Hanami::CLI::Registry\n",
+    "\n",
+    "      class Greet < Hanami::CLI::Command\n",
+    "\targument :name, required: true, desc: \"The name of the person to greet\"\n",
+    "\n",
+    "\tdef call(name:, **)\n",
+    "          result = \"Hello #{name}\"\n",
+    "\n",
+    "          puts result\n",
+    "\tend\n",
+    "      end\n",
+    "\n",
+    "      register \"hello\", Greet\n",
+    "    end\n",
+    "  end\n",
+    "end\n",
+    "\n",
+    "Hanami::CLI.new(Foo::CLI::Commands).call"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 比較\n",
+    ".コード量においてはthorが最も少なく簡潔で分かりやすい．\n",
+    "\n",
+    ".optparse及びhanamiではヘルプを自作する必要があるが，thorではその必要がなくruby thor.rbとだけ入力するとヘルプを表示する．\n",
+    "\n",
+    ".ruby optparse.rbと入力するとエラーが表示されるが，ruby hanami.rbでは使用可能なコマンドの一覧が表示される．"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# hanami\n",
+    "\n",
+    "hanami.rbのソースコード https://github.com/hanami/cli\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 2.3.3",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "2.3.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/docs/yagi/comparisons/hanami.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "hanami/cli"
+
+module Foo
+  module CLI
+    module Commands
+      extend Hanami::CLI::Registry
+
+      class Greet < Hanami::CLI::Command
+        argument :name, required: true, desc: "The name of the person to greet"
+
+        def call(name:, **)
+          result = "Hello #{name}"
+
+          puts result
+        end
+      end
+
+      register "hello", Greet
+    end
+  end
+end
+
+Hanami::CLI.new(Foo::CLI::Commands).call

data/docs/yagi/comparisons/optparse.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby
+require 'optparse'
+
+options = {:name => nil}
+
+parser = OptionParser.new do|opts|
+  opts.on('-n', '--name name', 'Give your own name') do |name|
+    options[:name] = name;
+    end
+
+  opts.on('-h', '--help', 'Displays Help') do
+    puts opts
+    exit
+    end
+end
+
+parser.parse!
+
+sayHello = 'Hello ' + options[:name]
+
+puts sayHello

data/docs/yagi/comparisons/thor.rb

@@ -0,0 +1,11 @@
+require 'thor'
+
+class MyCLI < Thor
+  desc "hello NAME", "say hello to NAME"
+  def hello(name)
+    puts "Hello #{name}"
+  end
+end
+
+
+MyCLI.start(ARGV)

data/docs/yagi/midterm_presentation/.ipynb_checkpoints/abst-checkpoint.ipynb

@@ -0,0 +1,87 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "コマンドツール作成ライブラリ Thor による my help の書き換え 情報科学科 27014534 大八木利治"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 背景\n",
+    "my help とはユーザー独自のマニュアルを作成することが できるユーザメモソフトである.これは terminal だけを用い て簡単に起動，編集，削除などをすることができるため，非 常に便利である.さらに，そのマニュアルは自分ですぐに編 集，参照することができるので，メモとしての機能も果たし ている.これにより，プログラミング初心者が，頻繁に使う コマンドやキーバインドなどをいちいち web browser を立ち 上げて調べるのではなく，terminal 上で即座に取得できるた め，プログラム開発を集中することが期待される.\n",
+    "しかし，my help にある問題のうちの一つとして挙げられ るのがサブコマンドの記述法である.\n",
+    "my help の振る舞いを制御しているサブコマンドは，マイ ナスを付した省略記法が取られている.プログラミング初 心者にとってこの省略記法は，覚えにくかったりわかりにく かったりするという問題があり，現在はフルワードを使った 自然言語に近い記述法が多く用いられている.\n",
+    "そこで，本研究ではコマンドラインツール作成ライブラリ を自然言語に近いサブコマンド体系を実装しやすいライブラ リである Thor に変更する.ruby の標準ライブラリである optparse で作成されている my help を，Thor[1] によって書 き直し，異なった 2 つライブラリで作成された my help の使 用感を比較検討することを目的とする."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# optparse について\n",
+    "今回の研究対象の my help は，optparse で実装されてい る.optparse が操作するオプションは，下記の on メソッド で設定する.\n",
+    "```\n",
+    "def execute\n",
+    "@argv << ’--help’ if @argv.size==0 command_parser = OptionParser.new do |opt|\n",
+    "opt.on(’-v’, ’--version’,’show␣program␣Version.’ ) { |v|\n",
+    "opt.version = MyHelp::VERSION puts opt.ver\n",
+    "}\n",
+    "opt.on(’-l’, ’--list’, ’list␣specific␣helps’){\n",
+    "list_helps}\n",
+    "中略\n",
+    "def list_helps\n",
+    "中略\n",
+    "end\n",
+    "後略\n",
+    "```\n",
+    "第 1 引数はショートオプションで，-a や -d のように設定する.同様にして，第 2 引数はロングオプションを表し，–add や –delete のように，第 3 引数はそのオプションの説明文で， help で表示される説明文を設定する.後ろのブロックには， そのオプションが指定された場合に実行されるコードを記述 する [2].しかしこのライブラリでは自然言語に近いサブコマ ンドを実装するには相当な書き換えが必要となる.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Thor について\n",
+    "\n",
+    "本研究では optparse の代わりのライブラリとして Thor の 採用を検討する.Thor は，コマンドラインツールの作成を支 援するライブラリであり，git や bundler のようにサブコマン ドを含むコマンドラインツールを簡単に作成することができ る [3].Thor には以下のような特徴がある.\n",
+    "1. コマンドラインオプションのパーズやサブコマンドごと のヘルプを作るなどの面倒な作業を簡単にこなすことが でき，手早くビルドツールや実行可能なコマンドを作成 できる [4].\n",
+    "2. 特殊な DSL (Domain Specific Language)を使わずに メソッドを定義することで処理を記述するため，テスト を行いやすい [4].\n",
+    "3. optparse では作成することが困難な，マイナスを伴わな い(自然言語に近い)サブコマンドを実装することが可 能である."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 展望\n",
+    "cli の option を parse する toolbox のランキングサイトに よると high line がもっともスコアが高い [5].highline でも 書き換えを行い，コード量およびコマンドの使いやすさ，覚 えやすさといった使用感についての比較検討を行う"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 2.3.3",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "2.3.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/docs/yagi/midterm_presentation/abst.aux

@@ -0,0 +1,16 @@
+\relax 
+\citation{erikhuda}
+\citation{MakuMakuOptParse}
+\citation{succi}
+\citation{hibariya}
+\citation{hibariya}
+\citation{toolbox}
+\bibcite{erikhuda}{1}
+\bibcite{MakuMakuOptParse}{2}
+\bibcite{succi}{3}
+\bibcite{hibariya}{4}
+\bibcite{toolbox}{5}
+\@writefile{toc}{\contentsline {section}{\numberline {1}背景}{1}}
+\@writefile{toc}{\contentsline {section}{\numberline {2}optparseについて}{1}}
+\@writefile{toc}{\contentsline {section}{\numberline {3}Thorについて}{1}}
+\@writefile{toc}{\contentsline {section}{\numberline {4}展望}{1}}

data/docs/yagi/midterm_presentation/abst.ipynb

@@ -0,0 +1,87 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "コマンドツール作成ライブラリ Thor による my help の書き換え 情報科学科 27014534 大八木利治"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 背景\n",
+    "my help とはユーザー独自のマニュアルを作成することが できるユーザメモソフトである.これは terminal だけを用い て簡単に起動，編集，削除などをすることができるため，非 常に便利である.さらに，そのマニュアルは自分ですぐに編 集，参照することができるので，メモとしての機能も果たし ている.これにより，プログラミング初心者が，頻繁に使う コマンドやキーバインドなどをいちいち web browser を立ち 上げて調べるのではなく，terminal 上で即座に取得できるた め，プログラム開発を集中することが期待される.\n",
+    "しかし，my help にある問題のうちの一つとして挙げられ るのがサブコマンドの記述法である.\n",
+    "my help の振る舞いを制御しているサブコマンドは，マイ ナスを付した省略記法が取られている.プログラミング初 心者にとってこの省略記法は，覚えにくかったりわかりにく かったりするという問題があり，現在はフルワードを使った 自然言語に近い記述法が多く用いられている.\n",
+    "そこで，本研究ではコマンドラインツール作成ライブラリ を自然言語に近いサブコマンド体系を実装しやすいライブラ リである Thor に変更する.ruby の標準ライブラリである optparse で作成されている my help を，Thor[1] によって書 き直し，異なった 2 つライブラリで作成された my help の使 用感を比較検討することを目的とする."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# optparse について\n",
+    "今回の研究対象の my help は，optparse で実装されてい る.optparse が操作するオプションは，下記の on メソッド で設定する.\n",
+    "```\n",
+    "def execute\n",
+    "@argv << ’--help’ if @argv.size==0 command_parser = OptionParser.new do |opt|\n",
+    "opt.on(’-v’, ’--version’,’show␣program␣Version.’ ) { |v|\n",
+    "opt.version = MyHelp::VERSION puts opt.ver\n",
+    "}\n",
+    "opt.on(’-l’, ’--list’, ’list␣specific␣helps’){\n",
+    "list_helps}\n",
+    "中略\n",
+    "def list_helps\n",
+    "中略\n",
+    "end\n",
+    "後略\n",
+    "```\n",
+    "第 1 引数はショートオプションで，-a や -d のように設定する.同様にして，第 2 引数はロングオプションを表し，–add や –delete のように，第 3 引数はそのオプションの説明文で， help で表示される説明文を設定する.後ろのブロックには， そのオプションが指定された場合に実行されるコードを記述 する [2].しかしこのライブラリでは自然言語に近いサブコマ ンドを実装するには相当な書き換えが必要となる.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Thor について\n",
+    "\n",
+    "本研究では optparse の代わりのライブラリとして Thor の 採用を検討する.Thor は，コマンドラインツールの作成を支 援するライブラリであり，git や bundler のようにサブコマン ドを含むコマンドラインツールを簡単に作成することができ る [3].Thor には以下のような特徴がある.\n",
+    "1. コマンドラインオプションのパーズやサブコマンドごと のヘルプを作るなどの面倒な作業を簡単にこなすことが でき，手早くビルドツールや実行可能なコマンドを作成 できる [4].\n",
+    "2. 特殊な DSL (Domain Specific Language)を使わずに メソッドを定義することで処理を記述するため，テスト を行いやすい [4].\n",
+    "3. optparse では作成することが困難な，マイナスを伴わな い(自然言語に近い)サブコマンドを実装することが可 能である."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 展望\n",
+    "cli の option を parse する toolbox のランキングサイトに よると high line がもっともスコアが高い [5].highline でも 書き換えを行い，コード量およびコマンドの使いやすさ，覚 えやすさといった使用感についての比較検討を行う"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 2.3.3",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "2.3.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}