my_help 0.4.3 → 0.4.4

data/my_help_nasu/method_cucumber.hiki

@@ -0,0 +1,184 @@
+{{toc}}
+!Cucumberについて
+!!概要
+Cucumberが提供するBDDの内容をまとめると
+""BDDはフルスタックのアジャイル開発技法です．BDDはATDP(Acceptance Test-Driven Planning)と呼ばれるAcceptance TDDの一種を含め，エクストリームプログラミングからヒントを得ています．ATDPでは，顧客受け入れテストを導入し，それを主体にコードの開発を進めて行きます．それらは顧客と開発チームによる共同作業の結果であることが理想的です．開発チームによってテストが書かれた後，顧客がレビューと承認を行うこともあります．いずれにしても，それらのテストは顧客と向き合うものなので，顧客が理解できる言語とフォーマットで表現されていなければなりません．Cucumberを利用すれば，そのための言語とフォーマットを手に入れることができます．Cucumberは，アプリケーションの機能とサンプルシナリオを説明するテキストを読み取り，そのシナリオの手順に従って開発中のコードとのやり取りを自動化します[1, 7pp.]．
+と記されている．
+
+!!features
+Cucumberでは先の引用にある通り、振る舞いをシナリオとしてまず記述します．
+次に，英語のfeaturesのひな形を示します．
+<<< ruby
+% cat ./featrues/sample_e.feature
+Feature: Description of feature
+
+Scenario: Description of scenario
+  Given I want to explain scenario
+  Then I investigate
+  When I know the meaning
+>>>
+
+ファイルの先頭で，
+ # language: ja
+と記すと日本語でのkeywordが認識されます．下記にmy_todoに対するfeaturesファイルの具体例を示します．
+<<< tcsh
+# language: ja
+
+機能: todoの更新を行う
+todoは更新していくものであり，新しく書いたり終わったものを消したいので
+バックアップをとって，過去のtodoを残しておく
+
+シナリオ: コマンドを入力してtodoを更新していく
+ 前提 todoを編集したい
+ もし "my_todo --edit"と入力する
+ ならば editが開かれる
+ かつ 自分のtodoを書き込む
+
+シナリオ: コマンドを入力してバックアップをとる
+ 前提 todoの編集が終わった
+ もし "my_todo --store [item]"と入力する
+ ならば itemのバックアップを取る
+>>>
+このようにFeature, Scenario, Given, Then, Whenなどのcucumberが解釈する大文字で始まる
+keywordsに対して，それぞれ機能，シナリオ，前提，もし，ならばなどの単語があてられています．
+この機能により，より自然な日本語でfeaturesを書くことができ，
+顧客にもわかりやすく，開発者も書きやすくなっています。
+
+featureファイルで用意されているkeywordは
+ cucumber --i18n LANG
+によって表示される．LANG=ja, enに対しては下記の通りになっています．
+
+|| keyword || ja(japanese) || en(english)
+||^ feature||^ "フィーチャ", "機能"    ||"Feature", "Business Need", 
+||"Ability"   ||
+|| background|| "背景"|| "Background" ||
+|| scenario|| "シナリオ"      || "Scenario"   ||
+||^^ scenario_outline || "シナリオアウトライン",||"Scenario Outline",
+|| "シナリオテンプレート","テンプレ",||^ "Scenario Template" ||
+|| "シナリオテンプレ" 
+|| examples|| "例", "サンプル" || "Examples", "Scenarios"        ||
+|| given ||"* ", "前提"      || "* ", "Given "        ||
+|| when ||"* ", "もし"      || "* ", "When "||
+|| then || "* ", "ならば"     || "* ", "Then "||
+|| and  || "* ", "かつ"      || "* ", "And " ||
+|| but  || "* ", "しかし", "但し", "ただし"|| "* ", "But " ||
+|| given (code) || "前提" || "Given"      ||
+|| when (code) || "もし"   ||  "When"       ||
+|| then (code) || "ならば" || "Then"       ||
+|| and (code)  || "かつ"   || "And"        ||
+|| but (code)  || "しかし", "但し","ただし" ||  "But"        ||
+
+!!Cucumber,RSpecインストール
+まずrspecをgemでinstallする．
+#gem install rspec --version 2.0.0
+#rspec --help
+と入力して
+<<< tcsh
+/Users/nasubi/nasu% rspec --help
+Usage: rspec [options] [files or directories]
+>>>
+のような表示がされていればinstallができている．次に，cucumberをinstallする
+#gem install cucumber --version 0.9.2
+#cucumber --help
+と入力して
+<<< tcsh
+cucumber --help
+Usage: cucumber [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+
+>>>
+のような表示がされていればinstallできている．
+
+!!ディレクトリー構造と使用手順
+cucumberはRubygemsの提供する基本directory構造での作業を前提としています．
+その構造を表示すると次のようになります．
+<<<
+bob% tree .
+.
+├── Gemfile
+├── Rakefile
+├── features
+│   ├── hogehoge.feature
+│   ├── step_definitions
+│   │   └── hogehoge_step.rb
+│   ├── support
+│       ├── env.rb
+├── lib
+│   ├── daddygongon
+│   │   ├── emacs_help.yml
+│   │   ├── my_todo.yml
+├── pkg
+├── spec
+│   ├── my_help_spec.rb
+│   ├── my_todo
+│   │   ├── todo_spec.rb
+│   ├── spec_helper.rb
+│   └── support
+│       └── aruba.rb
+>>>
+
+カレントディレクトリ(.)の中にfeaturesというサブディレクトリを作成します．
+そのfeaturesの中に書きたいシナリオを書いた，hogehoge.featureを作成します．
+featureの具体例は上記に示してします．
+
+次にシェルを開いて，カレントディレクトリで，
+ cucumber features hogehoge.feature
+と入力します．そうすると以下のような出力が得られます．
+<<< ruby
+Feature: Description of feature
+
+  Scenario: Description of scenario  # features/hogehoge.feature:3
+    Given I want to explain scenario # features/hogehoge.feature:4
+    Then I investigate      # features/hogehoge.feature:5
+    When I know the meaning # features/hogehoge.feature:6
+
+1 scenario (1 undefined)
+3 steps (3 undefined)
+0m0.066s
+
+You can implement step definitions for undefined steps with these snippets:
+
+Given(/^I want to explain scenario$/) do
+  pending # Write code here that turns the phrase above into concrete actions
+end
+
+Then(/^I investigate$/) do
+  pending # Write code here that turns the phrase above into concrete actions
+end
+
+When(/^I know the meaning$/) do
+  pending # Write code here that turns the phrase above into concrete actions
+end
+
+>>>
+
+ここではステップ定義に使用することができるコードブロックが表示されています．
+ステップ定義はステップを作成するための方法です．このサンプルでは，Giver(), When(), Then()の
+3つのメソッドを使ってステップを記述します．
+これらのメソッドはそれぞれ\/\/で囲まれたRegexp(正規表現)とブロックを受け取ります．
+Cucumberはシナリオの最初のステップを読み取り,そのステップにマッチする正規表現を持つステップ定義を探します．
+その中の対応するステップ定義のブロックを実行します．
+
+これはfeaturesディレクトリの下にstep_definitionsディレクトリーにあることになっています．
+このシナリオを成功させるには，Cucumberが読み込めるファイルにステップ定義を保存する必要があります[1, pp15.]．
+その内容は次の通りcucumberから自動生成されます．
+
+<<< ruby
+
+Given(/^I want to explain scenario$/) do
+  pending # Write code here that turns the phrase above into concrete actio\
+ns  
+end
+
+Then(/^I investigate$/) do
+  pending # Write code here that turns the phrase above into concrete actio\
+ns  
+end
+
+When(/^I know the meaning$/) do
+  pending # Write code here that turns the phrase above into concrete actio\
+ns  
+end
+
+>>>
+
+pendingを削除して，そこにあれば良いなと思うコードを記述していきます．
+ここまでがCucumberの使用方法のテンプレートです．

data/my_help_nasu/method_usage.hiki

@@ -0,0 +1,69 @@
+{{toc}}
+!my_helpについて
+!!使用法
+my_helpは本研究室の西谷が開発したものです．
+
+以下はmy_helpのREADMEです[2]．
+
+CUI(CLI)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
+
+# 問題点
+CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
+commandや文法を覚えるのに苦労します．少しのkey(とっかかり)があると
+思い出すんですが，うろ覚えでは間違えて路頭に迷います．問題点は，
+- manは基本的に英語
+- manualでは重たい
+- いつもおなじことをwebで検索して
+- 同じとこ見ている
+- memoしても，どこへ置いたか忘れる
+
+などです．
+
+# 特徴
+これらをgem環境として提供しようというのが，このgemの目的です．
+仕様としては，
+- userが自分にあったmanを作成
+- 雛形を提供
+  - おなじformat, looks, 操作, 階層構造
+- すぐに手が届く
+- それらを追加・修正・削除できる
+
+hikiでやろうとしていることの半分くらいはこのあたりのことなの
+かもしれません．memoソフトでは，検索が必要となりますが，my_helpは
+key(記憶のとっかかり)を提供することが目的です．
+
+!!my_helpのインストール
+!!githubに行ってdaddygongonのmy_helpをforkする
+#git clone git@github.com:daddygongon/my_help.git
+#cd my_help
+#rake to_yml
+#rake clean_exe
+#[sudo] bundle exec exe/my_help -m
+#source ~/.zshrc or source ~/.cshrc
+#my_help -l
+#rake add_yml
+
+!!my_helpの更新
+
+!!!gitを用いてmy_helpを新しくする．
+#git remote -vをする(remoteの確認).
+#(upstreamがなければ)git remote add upstream git@github.com:gitname/my_help.git
+#git add -A
+#git commit -m 'hogehoge'
+#git push upstream master(ここで自分のmy_helpをupstreamに送っとく)
+#git pull origin master(新しいmy_helpを取ってくる)
+
+!!!次にとってきた.ymlを~/.my_helpにcpする．
+#cd my_helpでmy_helpに移動．
+#cp hogehoge.yml ~/.my_help
+
+それを動かすために
+(sudo)bundle exec ruby exe/my_help -mをする.
+
+ここで過去にsudoをした人はpermissionがrootになっているので，sudoをつけないとerrorが出る．
+
+(sudoで実行していたら権限がrootに移行される)
+
+新しいターミナルを開いて動くかチェックする．
+
+

data/my_help_nasu/my_help_nasu.hiki

@@ -0,0 +1,32 @@
+{{toc}}
+
+!title:ユーザメモソフトmy_helpの開発
+!author:2535 那須比呂貴
+![[概要|my_help_nasu_overview]]
+
+![[序論|my_help_nasu_introduction]]
+!先行研究，方法
+ここでは、本研究で使用するcucumberの特徴について詳述する．
+cucumberはビヘイビア駆動開発(bdd)を実現するフレームワークである．
+まずはbddの現れた背景や現状を示した後、Cucumberの記述の具体例を示して，
+その特徴を詳述する．
+さらに，本研究の対象となるmy_helpの振る舞いを使用法とともに示す．
+
+!![[my_help_nasu_method_bdd]]
+!![[my_help_nasu_method_cucumber]]
+!![[my_help_nasu_method_usage]]
+
+![[本論|my_help_nasu_code]]
+!![[my_help_nasu_features]]
+![[結論,考察|my_help_nasu_consideration]]
+
+
+!謝辞
+　本研究を進めるにあたり，様々なご指導を頂きました西谷滋人教授先生に深く感謝いたします．
+また，本研究の進行に伴い，様々な助力，知識の供給を頂きました西谷研究室の同輩，先輩方に心から感謝の意を示します．
+本当にありがとうございました．
+
+!参考文献
+
+# The RSpec Book　著者：David Chelimsky Dave Astels Zach Dennis ほか　翻訳：株式会社クイーブ　監修：株式会社クイーブ　角谷信太郎　豊田裕司.
+# Shigeot R. Nishitani, my_helpのREADME, [[http://www.rubydoc.info/gems/my_help/0.4.3]].

data/my_help_nasu/overview.hiki

@@ -0,0 +1,11 @@
+　本研究ではユーザメモソフトであるmy_helpの開発において，BDDを取り入れることによりmy_helpの向上を目指した．
+
+　my_helpとは，ユーザメモソフトであり，user独自のhelpを作成・提供することができるgemである．
+しかし，これらの仕様方法を初心者が理解すること自体に時間がかかってしまうという問題点がある．
+そこで，cucumberを用いる．cucumberはRubyでBDDを実践するために用意された環境である．
+したがって，cucumberは振る舞いをチェックするために記述するが，そこで日本語がそのまま用いることが可能であるため，その記述を読むだけで，my_helpの振る舞いを理解することが可能となる．
+
+　cucumberは実際にソフトウェア開発の現場において，ユーザーとプログラマがお互いの意思疎通のために利用される．
+テストはプログラムがチェックしてくれるが，記述は人間が理解できなければならない．
+この二つの要求を同時に叶えようというのが，BDDの基本思想である．
+これらは，研究室の知識を定着させることに有益であり，研究室の役に立つと考えた．

data/tmp.txt

@@ -0,0 +1,2 @@
+文字を打つ.文字を打つ.
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_help
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Shigeto R. Nishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mathjax-yard
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,13 +109,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hiki2latex
+  name: systemu
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -109,7 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: systemu
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,11 +157,13 @@ executables:
 - e_h
 - emacs_help
 - my_help
-- todo_help
+- my_todo
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
@@ -147,27 +177,91 @@ files:
 - exe/e_h
 - exe/emacs_help
 - exe/my_help
-- exe/todo_help
+- exe/my_todo
 - hikis/README_en.hiki
 - hikis/README_ja.hiki
+- hikis/diff_against_org-mode.hiki
 - hikis/emacs_help.hiki
 - hikis/template_help.hiki
+- hikis/tmp.org
 - latexes/handout_pre.tex
+- lib/.emacs_help.rb.swp
 - lib/daddygongon/emacs_help.yml
-- lib/daddygongon/git_help.yml
+- lib/daddygongon/my_todo.yml
 - lib/daddygongon/template_help.yml
-- lib/daddygongon/todo_help.yml
 - lib/emacs_help.rb
+- lib/emacs_help.rb~
 - lib/my_help.rb
 - lib/my_help/test.rb
 - lib/my_help/version.rb
+- lib/my_todo/my_todo.rb
+- lib/my_todo/my_todo.rb~
 - lib/specific_help.rb
+- lib/specific_help.rb~
+- lib/todo.rb
+- lib/todo.rb~
+- lor
 - my_help.gemspec
 - my_help.wiki/Home.md
 - my_help.wiki/README_en.md
 - my_help.wiki/README_ja.md
 - my_help.wiki/emacs_help.md
 - my_help.wiki/template_help.md
+- my_help_nasu/.DS_Store
+- my_help_nasu/.gitignore
+- my_help_nasu/Rakefile
+- my_help_nasu/code.hiki
+- my_help_nasu/consideration.hiki
+- my_help_nasu/features.hiki
+- my_help_nasu/figs/my_help_nasu.001.jpeg
+- my_help_nasu/figs/my_help_nasu.001.jpg
+- my_help_nasu/figs/my_help_nasu1.001.jpg
+- my_help_nasu/head2.tex
+- my_help_nasu/hiki_help.yml
+- my_help_nasu/introduction.hiki
+- my_help_nasu/key_bind_mi
+- my_help_nasu/latex_dir/.gitignore
+- my_help_nasu/latex_dir/Rakefile
+- my_help_nasu/latex_dir/code.aux
+- my_help_nasu/latex_dir/code.tex
+- my_help_nasu/latex_dir/consideration.aux
+- my_help_nasu/latex_dir/consideration.tex
+- my_help_nasu/latex_dir/features.aux
+- my_help_nasu/latex_dir/features.tex
+- my_help_nasu/latex_dir/head.tex
+- my_help_nasu/latex_dir/hiki_help.yml
+- my_help_nasu/latex_dir/introduction.aux
+- my_help_nasu/latex_dir/introduction.tex
+- my_help_nasu/latex_dir/jlisting.sty
+- my_help_nasu/latex_dir/jlisting.tex
+- my_help_nasu/latex_dir/latex_dir/head.tex
+- my_help_nasu/latex_dir/latex_dir/jlisting.tex
+- my_help_nasu/latex_dir/latex_dir/pre.tex
+- my_help_nasu/latex_dir/method_bdd.aux
+- my_help_nasu/latex_dir/method_bdd.tex
+- my_help_nasu/latex_dir/method_cucumber.aux
+- my_help_nasu/latex_dir/method_cucumber.log
+- my_help_nasu/latex_dir/method_cucumber.tex
+- my_help_nasu/latex_dir/method_usage.aux
+- my_help_nasu/latex_dir/method_usage.tex
+- my_help_nasu/latex_dir/my_help_nasu.aux
+- my_help_nasu/latex_dir/my_help_nasu.log
+- my_help_nasu/latex_dir/my_help_nasu.pdf
+- my_help_nasu/latex_dir/my_help_nasu.synctex.gz
+- my_help_nasu/latex_dir/my_help_nasu.tex
+- my_help_nasu/latex_dir/my_help_nasu.toc
+- my_help_nasu/latex_dir/overview.aux
+- my_help_nasu/latex_dir/overview.tex
+- my_help_nasu/latex_dir/pre.tex
+- my_help_nasu/method_bdd.hiki
+- my_help_nasu/method_cucumber.hiki
+- my_help_nasu/method_usage.hiki
+- my_help_nasu/my_help_nasu.hiki
+- my_help_nasu/my_help_nasu.key
+- my_help_nasu/my_help_nasu/.DS_Store
+- my_help_nasu/my_help_nasu/my_help_nasu.001.jpeg
+- my_help_nasu/overview.hiki
+- tmp.txt
 homepage: https://github.com/daddygongon/my_help
 licenses:
 - MIT

data/lib/daddygongon/git_help.yml

@@ -1,30 +0,0 @@
----
-:head:
-- git help
-:license:
-- "     cc by Shigeto R. Nishitani, 2016"
-:proxy:
-  :opts:
-    :short: "-p"
-    :long: "--proxy"
-    :desc: proxy
-  :title: proxy
-  :cont:
-  - 'tsch: setenv http_proxy http://proxy.kwansei.ac.jp:8080'
-  - 'tsch: setenv https_proxy http://proxy.kwansei.ac.jp:8080'
-  - 'zch: export http_proxy=http://proxy.kwansei.ac.jp:8080'
-  - 'zch: export https_proxy=http://proxy.kwansei.ac.jp:8080'
-:basic:
-  :opts:
-    :short: "-b"
-    :long: "--basic"
-    :desc: basic
-  :title: basic
-  :cont:
-  - Fork from https://github.com/daddygongon/my_help
-  - "git clone git@github.com:[hogehoge]/my_help.git"
-  - cd my_help
-  - git add -A
-  - git commit -m 'first commit'
-  - git push origin master
-  - git pull origin master

data/lib/daddygongon/todo_help.yml

@@ -1,58 +0,0 @@
-# -*- coding: utf-8 -*-
----
-#start header, which appears every time.
-:head:         #never change
-- todoを作るhelp
-:license:
-- "     cc by Shigeto R. Nishitani, 2016"
-
-:install: #text here too
-  :opts:
-    :short: -i
-    :long: --install
-    :desc: "my_helpのinstall"
-  :title: "my_helpのinstall"
-  :cont:
-  - "[sudo] gem uninstall my_help"
-  - "自分[hogehoge]のgithubにある古いmy_helpをdelete"
-  - "Fork from https://github.com/daddygongon/my_help"
-  - "[sudo] rm -rf my_help"
-  - "git clone git@github.com:[hogehoge]/my_help.git"
-  - "cd my_help"
-  - "rake to_yml"
-  - "[sudo] bundle exec exe/my_help -c"
-  - "[sudo] bundle exec exe/my_help -m"
-  - "新しいterminalを開ける"
-  - "my_help -l"
-  - "rake add_yml"
-  - "--editで編集画面を開けてみて，色が付いてなかったら，"
-  - "mv ~/.emacs ~/.emacs.d/init.elを試してみる"
-
-:make: #text here too
-  :opts:
-    :short: -m
-    :long: --make
-    :desc: 新しいhelpをmake
-  :title: 新しいhelpをmake
-  :cont:
-  - "cd my_help"
-  - "bundle exec exe/my_help -i ruby_help"
-  - "bundle exec exe/my_help -e ruby_help"
-  - "[sudo] bundle exec exe/my_help -m"
-
-:todo2hiki:
-  :opts:
-    :short: -t
-    :long: --todo
-    :desc: todoの内容をhikiに移す
-  :title: todoの内容をhikiに移す
-  :cont:
-  - hikiにlogin
-  - Seminar2016fを編集
-  - "*[[seminar_2016_11_25]]を入力"
-  - そこのlinkを選ぶ
-  - "{{toc}} {{bbs}を入力して保存"
-  - "todo_help --to_hiki"
-  - weeklyをcopy
-  - pasteしていく
-