my_help 0.4.5 → 0.5.0

data/docs/nasu/features/backup_list.feature

@@ -0,0 +1,10 @@
+#language: ja
+
+#--backup_list
+機能: 過去にバックアップしてあるitemのリストを表示させる
+何をバックアップしたかの確認をしたい
+
+シナリオ: コマンドを入力してバックアップのリストを見る
+        前提 バックアップのリストを見たい
+        もし emacs_help --backup_listを入力する
+        ならば バックアップしているitemのリストが表示される

data/docs/nasu/features/edit_help.feature

@@ -0,0 +1,9 @@
+# language: ja
+#--edit
+機能: helpコマンドの追加や削除，編集をするためのeiditを開く
+emacs_helpと入力したときに出てくるhelpのコマンドの追加や削除，編集ができる
+
+シナリオ: コマンドを入力してeditを開く
+        前提 emacs_helpのコマンドの編集がしたい
+        もし emacs_help --editと入力する
+        ならば ~/.my_help/emacs_help.ymlがemacsで開かれる

data/docs/nasu/features/my_todo.feature

@@ -0,0 +1,16 @@
+# language: ja
+
+機能: todoの更新を行う
+自分のするべきことを書き込むためにtodoを更新する
+
+
+シナリオ: コマンドを入力してtodoを更新していく
+	  前提 todoを編集したい
+	  もし "my_todo --edit"と入力する
+	  ならば editが開かれる
+	  かつ 自分のtodoを書き込む
+
+#シナリオ: コマンドを入力してバックアップをとる
+#	  前提 todoの編集が終わった
+#	  もし "my_todo --store [item]"と入力する
+#	  ならば itemのバックアップを取る

data/docs/nasu/features/remove.feature

@@ -0,0 +1,10 @@
+#language: ja
+
+#--remove [item]
+機能: specific_helpのitemを消す
+いらなくなったitemを消したいときに使う
+
+シナリオ: コマンドを入力してitemを消す
+        前提 いらないitemを消したい
+        もし emacs_help remove [item]
+        ならば ~/.my_help/emacs_help.ymlからitemが消える

data/docs/nasu/features/sample_e.feature

@@ -0,0 +1,6 @@
+Feature: Description of feature
+
+Scenario: Description of scenario
+  Given I want to explain scenario
+  Then I investigate
+  When I know the meaning

data/docs/nasu/features/step_definitions/add_spec.rb

@@ -0,0 +1,18 @@
+def input
+  command = "emacs_help --add [item]"
+end
+
+def add
+end
+
+前提(/^新たなhelpコマンドを追加したい$/) do
+  
+end
+
+もし(/^emacs_help \-\-add\[item\]を入力する$/) do 
+  input
+end
+
+ならば(/^~\/\.my_help\/emacs_help\.ymlに新しいitemが自動的に追加される$/) do 
+  add
+end

data/docs/nasu/features/step_definitions/all_help_spec.rb

@@ -0,0 +1,18 @@
+def input
+  commands = "emacs_help --all"
+end
+
+def display_all
+end
+
+前提(/^複数のhelp画面を表示したい$/) do
+
+end
+
+もし(/^emacs_help \-\-allと入力する$/) do
+  input
+end
+
+ならば(/^すべてのhelp画面が表示される$/) do
+  display_all
+end

data/docs/nasu/features/step_definitions/backup_list_spec.rb

@@ -0,0 +1,18 @@
+def input
+  command = "emacs_help --backup_list"
+end
+
+def display_list
+end
+
+前提(/^バックアップのリストを見たい$/) do
+
+end
+
+もし(/^emacs_help \-\-backup_listを入力する$/) do
+    input
+end
+
+ならば(/^バックアップしているitemのリストが表示される$/) do
+  display_list
+end

data/docs/nasu/features/step_definitions/edit_help_spec.rb

@@ -0,0 +1,19 @@
+def input
+  command = "emacs_help --edit"
+end
+
+def open
+#  f = File.open("~/.my_help/emacs_help.yml")
+end
+
+前提(/^emacs_helpのコマンドの編集がしたい$/) do
+
+end
+
+もし(/^emacs_help \-\-editと入力する$/) do
+  input
+end
+
+ならば(/^~\/\.my_help\/emacs_help\.ymlがemacsで開かれる$/) do
+  open
+end

data/docs/nasu/features/step_definitions/my_todo_spec.rb

@@ -0,0 +1,25 @@
+前提(/^todoを編集したい$/) do
+  
+end
+
+もし(/^"([^"]*)"と入力する$/) do |command|
+
+end
+ならば(/^editが開かれる$/) do
+  Mytodo::Edit.new.open  
+end
+
+ならば(/^自分のtodoを書き込む$/) do
+
+end
+
+=begin
+前提(/^todoの編集が終わった$/) do
+
+end
+
+ならば(/^itemのバックアップを取る$/) do
+
+end
+
+=end

data/docs/nasu/features/step_definitions/remove_spec.rb

@@ -0,0 +1,18 @@
+def input
+  command = "emacs_help remove [item]"
+end
+
+def remove
+end
+
+前提(/^いらないitemを消したい$/) do
+
+end
+
+もし(/^emacs_help remove \[item\]$/) do
+  input
+end
+
+ならば(/^~\/\.my_help\/emacs_help\.ymlからitemが消える$/) do
+  remove
+end

data/docs/nasu/features/step_definitions/store_spec.rb

@@ -0,0 +1,18 @@
+def input
+  command = "emacs_help --store [item]"
+end
+
+def backup
+end
+
+前提(/^バックアップをとっておきたい$/) do
+
+end
+
+もし(/^emacs_help \-\-store \[item\]と入力する$/) do
+  input
+end
+
+ならば(/^入力したitemのバックアップが作られる$/) do
+  backup
+end

data/docs/nasu/features/step_definitions/to_hiki_spec.rb

@@ -0,0 +1,18 @@
+def input
+  command = "eacs_help --to_hiki"
+end
+
+def convert
+end
+
+前提(/^hikiモードに変更したい$/) do
+
+end
+
+もし(/^emacs_help \-\-to_hikiと入力する$/) do
+  input
+end
+
+ならば(/^formatがhikiモードに変更される$/) do
+  convert
+end

data/docs/nasu/features/store.feature

@@ -0,0 +1,10 @@
+#language: ja
+
+#--store [item]
+機能: itemのバックアップを取る
+バックアップとして残したいitemがあるときに使う
+
+シナリオ: コマンドを入力してitemのバックアップをとる
+        前提 バックアップをとっておきたい
+        もし emacs_help --store [item]と入力する
+        ならば 入力したitemのバックアップが作られる

data/docs/nasu/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+require 'todo'

data/docs/nasu/features/test.feature

@@ -0,0 +1,10 @@
+#language: ja
+フィーチャ: 除算
+  バカな間違いを避けるために
+  有理数も計算できること
+
+  シナリオ: ふつうの数値
+    前提 3 を入力
+    かつ 2 を入力
+    もし divide を押した
+    ならば 1.5 を表示

data/docs/nasu/features/to_hiki.feature

@@ -0,0 +1,10 @@
+# language: ja
+
+#--to_hiki
+機能:formatをhikiモードに変更する
+一つ一つエディタで開いて変更するのがめんどくさい時に有益である
+
+シナリオ: コマンドを入力してformatをhikiモードに変える
+        前提 hikiモードに変更したい
+        もし emacs_help --to_hikiと入力する
+        ならば formatがhikiモードに変更される

data/{my_help_nasu → docs/nasu}/features.hiki

@@ -1,10 +1,10 @@
 {{toc}}
-!!featuresでの記述とその意味
-featuresでの記述は，コマンドの振る舞いを説明する自然な記述となる．
-その様子をspecific_helpが用意しているデフォルトのコマンドについて
-説明する．specific_helpとは，ユーザが作成するそれぞれのヘルプである．
+!featuresでの記述とその意味
+featuresでの記述は，コマンドの振る舞いを説明する自然な記述です．
+その様子をspecific_helpが用意しているデフォルトのコマンドについて説明します．
+specific_helpとは，ユーザが作成するそれぞれのヘルプです．
 speific_helpの--helpを表示させると，
-<<< 
+<<< tcsh
         --edit                       edit help contentsを開く
         --to_hiki                    hikiのformatに変更する
         --all                        すべてのhelp画面を表示させる
@@ -13,20 +13,15 @@ speific_helpの--helpを表示させると，
         --add [item]                 add new [item]で新しいhelpを作る
         --backup_list [val]          back upしているlistを表示させる
 >>>
-が得られる．これらの項目について順に詳細な振る舞いとそれを記述する
-シナリオを検討していく．
-
-
-!!my_helpのfeatures
-下記は私が作成したmy_helpの一部をfeaturesで書いたものである．
+が得られます．
+これらの項目について順に詳細な振る舞いとそれを記述するシナリオを検討していきます．
 
-!!!--add [item]
-このコマンドは新しいitemをspecific_helpに追加する．
-提供される機能を
-シナリオの先頭に内容をかいつまんでこの振る舞いが記述されている．
-実装では，ヘルプの内容は~/.my_help/emacs_help.ymlに元dataがある
+!!--add [item]
+このコマンドは新しいitemをspecific_helpに追加します．
+提供される機能をシナリオの先頭に内容をかいつまんでこの振る舞いが記述されています．
+実装では，ヘルプの内容は~/.my_help/emacs_help.ymlに元dataがあります．
 
-<<< 
+<<< ruby
 nasu% cat add.feature
 #language: ja
 
@@ -42,10 +37,13 @@ specific_helpとは，ユーザが作成するそれぞれのヘルプである
 
 >>>
 
+!!--all
+このコマンドはspecific_helpにあるhelpを一度に全て表示させます．
+するとspecific_helpにあるitemを全て表示します．
+実装では，元データが~/.my_help/emacs_help.ymlにあるので，それを全て表示します．
 
-!!!全てのhelp画面の表示
-<<< all_help.feature
-
+<<< ruby
+nasu% cat all_help.feature
 #language: ja
 
 #--all
@@ -57,12 +55,14 @@ specific_helpとは，ユーザが作成するそれぞれのヘルプである
         もし emacs_help --allと入力する
         ならば すべてのhelp画面が表示される
 >>>
-シナリオ：コマンドをニュ力してすべてのhelp画面を見る
 
-コマンド：emacs_help --all
 
-!!!過去にバックアップしてあるitemのリストの表示
-<<< backup_list.feature
+!!--backup_list
+このコマンドは過去にバックアップをとったことのあるitemを表示させます．
+自分がどのitemをバックアップしたのかの確認ができます．
+また，そのitemのバックアップをとった時間も表示されるので，いつバックアップをとったのかの確認もできます．
+<<< ruby
+nasu% cat backup_list.feature
 #language: ja
 
 #--backup_list
@@ -75,11 +75,14 @@ specific_helpとは，ユーザが作成するそれぞれのヘルプである
         ならば バックアップしているitemのリストが表示される
         
 >>>
-シナリオ：コマンドを入力してバックアップのリストを見る
-コマンド：emacs_help --backup_list
 
-!!!helpコマンドの追加や削除，編集をするファイルの開示
-<<< edit_help.feature
+
+!!--edit
+このコマンドはspecific_helpのitemの編集ができます．
+実装では，元データのある~/.my_help/emacs_help.ymlがemacsで開かれ，自分で編集ができます．
+編集作業が終了したら，emacsで開かれているので， [C-x C-s]で保存，[C-x C-c]でeditを閉じます．
+<<< ruby
+nasu% cat edit_help.feature
 # language: ja
 #--edit
 機能: helpコマンドの追加や削除，編集をするためのeiditを開く
@@ -90,15 +93,13 @@ emacs_helpと入力したときに出てくるhelpのコマンドの追加や削
         もし emacs_help --editと入力する
         ならば ~/.my_help/emacs_help.ymlがemacsで開かれる
 >>>
-シナリオ：コマンドを入力してeditを開く
-コマンド：emacs_help --edit
-
-元dataである~/.my_help/emacs_help.ymlを開く．
-
-ここで編集を行い，emacsで開いているのでC-x,C-sで保存する．
 
-!!!specific_helpのitemの消去
-<<< remove.feature
+!!--remove [item]
+このコマンドは新しいitemをspecific_helpから削除します．
+提供される機能をシナリオの先頭に内容をかいつまんでこの振る舞いが記述されています．
+実装では，ヘルプの内容は~/.my_help/emacs_help.ymlに元dataがあります．
+<<< ruby
+nasu% cat remove.feature
 #language: ja
 
 #--remove [item]
@@ -111,12 +112,16 @@ emacs_helpと入力したときに出てくるhelpのコマンドの追加や削
         ならば ~/.my_help/emacs_help.ymlからitemが消える
 
 >>>
-シナリオ：コマンドを入力してitemを消す
 
-コマンド：emacs_help --remove
-
-!!!itemのバックアップ
-<<< store.feature
+!!--store [item]
+このコマンドはspecific_helpのitemのバックアップをとります．
+少しhelpを新しくしたいが，過去のhelpを残しておけば安心できます．
+~/.my_helpディレクトリーの中に，同じ名前の先頭に'.'をつけたファイルに追記されていきます．
+ -rw-r--r--   1 bob  501   3231  2 10 17:11 my_todo.yml
+ -rw-r--r--   1 bob  501  31925  2  3 19:49 .my_todo.yml
+などとしてます．
+<<< ruby
+nasu% cat store.feature
 #language: ja
 
 #--store [item]
@@ -129,12 +134,33 @@ emacs_helpと入力したときに出てくるhelpのコマンドの追加や削
         ならば 入力したitemのバックアップが作られる
 >>>
 
-シナリオ：コマンドを入力してバックアップをとる
+!!--to_hiki
+このコマンドはformatをhikiに変更します．
+
+<<< 
+:カーソル移動:cursor
+*C-f, move Forwrard,    前or右へ
+*C-b, move Backwrard,   後or左へ
+*C-a, go Ahead of line, 行頭へ
+*C-e, go End of line,   行末へ
+*C-n, move Next line,   次行へ
+*C-p, move Previous line, 前行へ
+>>>
+などとhiki記法で出力されます．これをhikiの本文中に入れると
+:カーソル移動:cursor
+*C-f, move Forwrard,    前or右へ
+*C-b, move Backwrard,   後or左へ
+*C-a, go Ahead of line, 行頭へ
+*C-e, go End of line,   行末へ
+*C-n, move Next line,   次行へ
+*C-p, move Previous line, 前行へ
+などとweb上で表示されます．
+
 
-コマンド：emacs_help --store [item]
+//使用方法がわからない．--allと変わらない振る舞いをする．
 
-!!!hikiへのformatの変更
-<<< to_hiki.feature
+<<< ruby
+nasu% cat to_hiki.feature
 # language: ja
 
 #--to_hiki
@@ -146,17 +172,19 @@ emacs_helpと入力したときに出てくるhelpのコマンドの追加や削
         もし emacs_help --to_hikiと入力する
         ならば formatがhikiモードに変更される
 >>>
-シナリオ：コマンドを入力してformatをhikiモードにする
 
-コマンド：emacs_help --to_hiki
-
-!!!todoの更新
-<<< my_todo.feature
+!!todoの更新
+まず，todoを書き込むために，editを開くために，my_todo --editと入力します．
+--editコマンドは上記で説明した動きをします．
+しかし，ここでは元データは~/.my_help/todo_help.ymlです．
+editが開かれたら，todoを書き込みます．（今週やることならweeklyというitemを作ってそこに書き込む）
+保存方法や，editの閉じ方はemacsと同じ操作方法です．
+<<< ruby
+nasu% my_todo.feature
 # language: ja
 
 機能: todoの更新を行う
-todoは更新していくものであり,新しく書いたり終わったものを消したいのでバック\
-アップをとって，過去のtodoを残しておく
+自分のするべきことを書き込むためにtodoを更新する
 
 シナリオ: コマンドを入力してtodoを更新していく
           前提 todoを編集したい
@@ -164,22 +192,4 @@ todoは更新していくものであり,新しく書いたり終わったもの
           ならば editが開かれる
           かつ 自分のtodoを書き込む
 
-シナリオ: コマンドを入力してバックアップをとる
-          前提 todoの編集が終わった
-          もし "my_todo --store [item]"と入力する
-          ならば itemのバックアップを取る
 >>>
-シナリオ１：コマンドを入力してtodoを更新する
-シナリオ２：コマンドを入力してバックアップをとる
-
-コマンド１：my_todo --edit
-コマンド２：my_todo --store [item]
-
-my_todo --editで~/.my_help/my_todo.ymlを開く．
-
-ここで編集を行い，emacsで開いているのでC-x,C-sで保存する．
-
-my_todo --store [item]でtodoのitemをバックアップとっておく．
-
-この動作により過去のバックアップを閲覧することができ，どんどん更新することが可能である．
-

data/{my_help_nasu → docs/nasu}/introduction.hiki

@@ -1,29 +1,28 @@
 // 目的の前に何が問題があって，何を解決するのかが描かれるべきです．
 !序論
 //!!my_helpというソフト
-プログラム開発では，統合開発環境がいくつも用意されているが，多くの現場では，terminal上での開発が一般的である．
-ところが，プログラミング初心者はterminal上でのcharacter user interface(CUI)を苦手としている．
-プログラミングのレベルが上がるに従って，
-shell commandやfile directory操作, process制御にCUIを使うことが常識となる．
+プログラム開発では，統合開発環境がいくつも用意されているが，多くの現場では，terminal上での開発が一般的です．
+ところが，プログラミング初心者はterminal上でのcharacter user interface(CUI)を苦手としています．
+プログラミングのレベルが上がるに従って，shell commandやfile directory操作, process制御にCUIを使うことが常識です．
 
-この不可欠なCUIスキルの習得を助けるソフトとして，ユーザメモソフトmy_helpがruby gemsに置かれている．
-このcommand line interface(CLI)で動作するソフトは，helpをterminal上で簡単に提示するものである．
-また，初心者が自ら編集することによって，すぐに参照できるメモとしての機能を提供している．
+この不可欠なCUIスキルの習得を助けるソフトとして，ユーザメモソフトmy_helpがruby gemsに置かれています．
+このcommand line interface(CLI)で動作するソフトは，helpをterminal上で簡単に提示するものです．
+また，初心者が自ら編集することによって，すぐに参照できるメモとしての機能を提供しています．
 これによって，terminal上でちょっとした調べ物ができるため，作業や思考が中断することなく
-プログラム開発に集中できることが期待でき，初心者のスキル習得が加速することが期待できる．
+プログラム開発に集中できること，さらに初心者のスキル習得が加速することが期待できます．
 
 //!!共同開発のためには，テストが必要だが，不十分．
-しかし，Ruby gemsとして提供されているこのソフトは，動作はするがテストが用意されていない．
-慣れた開発者は，テストを見ることで仕様を理解するのが常識である．
-今後ソフトを進化させるために共同開発を進めていくには，仕様や動作の標準となるテスト記述が不可欠となる．
+しかし，Ruby gemsとして提供されているこのソフトは，動作はしますがテストが用意されていません．
+熟練した開発者は，テストを見ることで仕様を理解するのが常識です．
+今後ソフトを進化させるために共同開発を進めていくには，仕様や動作の標準となるテスト記述が不可欠となります．
 
 
 //!!BDDに従ってテストを書いていく
 //以下は残しておきますが，適当な時に消してください．
 //本研究の目的は，ユーザメモソフトであるmy_helpのテスト開発です．
-そこで，本研究では，ユーザメモソフトであるmy_helpのテストを開発することを目的とする．
-本研究では、テスト駆動開発の中でも，ソフトの振る舞いを記述する
-Behavior Driven Development(BDD)に基づいてテストを記述していく．
+そこで，本研究では，ユーザメモソフトであるmy_helpのテストを開発することを目的とします．
+本研究では、テスト駆動開発の中でも，ソフトの振る舞いを記述します．
+ビヘイビア駆動開発(Behavior Driven Development:BDD)に基づいてテストを記述していきます．
 Rubyにおいて、BDD環境を提供する標準的なフレームワークであるCucumberとRSpecを用いて，
-my_helpがどのような振る舞いをするのかを記述する．
-Cucumberは自然言語で振る舞いを記述することができるため，ユーザにとって，わかりやすく振る舞いを確認することができる．
+my_helpがどのような振る舞いをするのかを記述します．
+Cucumberは自然言語で振る舞いを記述することができるため，開発者やユーザにとって，わかりやすく振る舞いを確認することができます．