githelp 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ae34b6dff910ff07f8bce378c54a36b9577e7ac
-  data.tar.gz: 373bd1ad1df3196d5f03bd83179a9a26385c3951
+  metadata.gz: b44761785f5b8f6abed97dd864aea2e911e5f0d5
+  data.tar.gz: b6c93ae5afa51e4c494889b34972b4c3e4925a91
 SHA512:
-  metadata.gz: 268667e02e34302a0b1b115cd2cb53d4f4a7b71619af84876d399a0377d507ee775d71cbcbf1f7117bc0ff661ddfcaad18ee1e5a34b7541aedfedc7f299861c3
-  data.tar.gz: 16700527a1ee421a41e128c895e2a9e8c3ea54308140c8378ef4843e4a5eba938e41b45c524305aa897117ffba2ace120ff4d527090fbfeeb5d2a5a6a1328923
+  metadata.gz: adea99c99d34a612f79debe607244654dea9cb109a0a4a417b263cde33c40d0d3f63aa892ee5a5e151f94907cd1f9907db163c7d1180dfbdbc2020a468cff2ab
+  data.tar.gz: d850c7a51e1088e84fce305ba7ea7f1a12c9f4763bffd7a08d436b26659a3a6f6c16a2415e41047d2306532675345ef57b8d8525537a3bb4c3dd1a507fd6d7b4

data/.gitignore

@@ -1,2 +1,3 @@
 *~
 Gemfile.lock
+pkg

data/README.md

@@ -1,23 +1,35 @@
 # GitHelp
 
-**Gitのコマンドの使いこなしを支援する**
+**Gitのコマンドの使いこなしを支援**
 
-### 解決したい問題
+### 概要
 
-* Gitの使い方や引数指定方法がさっぱりわからないこと
-* ちょっとしたことでもどうコマンドを組み合わせれば良いのかわからないこと
+Gitのような複雑なシステムは使い方がわからなくて苦労する。
+ある程度使い方を知っている場合でも
+あまり標準的でない操作は難しい。
+たとえば以下のような場合は
+どういうコマンドを使えばいいだろうか?
 
-以下のような処理をGitでどうやって実行するかを教えてくれる
-
-* example.txtは3日前からどう変わった?
-* 3日前のexample.txtを見たい
+* README.mdは3日前からどう変わった?
+* 3日前のREADME.mdを見たい
 * package.jsonからcoffeeという名前が消えたのはいつ?
 * ここ1週間ぐらい変更されてないファイルは?
 * 最近最も大量に修正したファイルはどれだっけ?
 
+複雑なシステムにはヘルプやマニュアルが用意されているのが普通だし、
+FAQや逆引き辞典が用意されていることもあるし、
+答がWebでみつかることもあるが、
+うまく検索できないことも多いし、
+やり方がわかった場合でも
+キーワードやパラメタを指定して実行しなおす必要があるので手間がかかる。
+***このような問題を[ExpandHelp](http://www.interaction-ipsj.org/archives/paper2012/data/Interaction2012/oral/data/pdf/12INT012.pdf)で解決する。***
+
 ### 利用例
 
-* ```README``` ```8``` ```比較``` のような引数を指定して```githelp```コマンドを起動すると以下のような候補が提示される
+Gitに関連するタスクのキーワードやパラメタを指定すると
+候補のリストが表示され、選択すると実行される。
+
+* ```README``` ```8``` ```比較``` のような引数を指定して```githelp```コマンドを起動すると以下のような候補リストが提示される
 
 ```
 $ githelp README 8 比較
@@ -30,7 +42,7 @@ $ githelp README 8 比較
 $
 ```
 
-* ```-x``` オプションで数字を指定すると実行できる
+* ```-x``` オプションで```2```のような数字を指定すると実行できる
 
 
 ```
@@ -45,35 +57,69 @@ index 862f185..34c8907 100644
 -**Gitのコマンドの使いこなしを支援する**
 -
 -### 解決したい問題
--
--* Gitの使い方や引数指定方法がさっぱりわからないこと
--* ちょっとしたことでもどうコマンドを組み合わせれば良いのかわからないこと
 ...
 ```
 
 * ```-i``` オプションを指定すると対話的に選択できる
-* 引数なしで```githelp```を起動するとリストが表示される
 
+### インストール
 
-### 実装
+```
+% gem install githelp
+```
 
-* [ExpandHelp](https://github.com/masui/expand_ruby)を利用
-* [ExpandHelp論文](http://www.interaction-ipsj.org/archives/paper2012/data/Interaction2012/oral/data/pdf/12INT012.pdf)
-* [```data```](https://github.com/masui/GitHelp/tree/master/data)ディレクトリの下に問題パタンと解決コマンドを書く
-   * ワンライナーで無理な場合は ```bin``` の下にコマンドを用意する
+### 実装
 
-### インストール
+* [re_expand](https://github.com/masui/expand_ruby)
+という正規表現展開ライブラリを利用
+* [```data```](https://github.com/masui/GitHelp/tree/master/data)ディレクトリの下に**問題パタン**と**解決コマンド**を並べたものを用意しておく
 
 ```
-% gem install githelp
+[
+  "「(#{files.join('|')})」ファイルを(#{numbers.join('|')})分前の(もの|バージョン)と比較する",
+  'git diff HEAD "@{#{$2} minutes ago}" #{$1}'
+],
 ```
 
+* ファイル名にマッチする引数(e.g. ```README```)や
+数字にマッチする引数(e.g. ```8```)が指定されると1行目の記述にマッチすることになる
+* ワンライナーでは難しい場合は [```exe```](https://github.com/masui/GitHelp/tree/master/exe) の下にヘルパーコマンドを用意する (e.g. [```exe/githelp-changed```](https://github.com/masui/GitHelp/tree/master/exe/githelp-changed) )
+
+### 解説
+
+* ExpandHelp方式とは、
+様々なタスクの説明と実際の操作を組にして記述しておき、
+ユーザが与えたキーワードやパラメタにマッチするものを
+リストして実行可能にするというものである。
+* いろんなクエリに対応できるようにするため説明は正規表現で記述しておく。
+たとえばシステムの時刻をセットする機能の説明は```(時計|時刻|時間)を((設定|セット)する|あわせる)```
+のような正規表現で記述しておくことにより、```時刻をセットする``` ```時間をあわせる```
+などのクエリにマッチするようにする。
+* 「README.mdを消す方法」はマニュアルには書いてない。
+「ファイルを消す方法」しか書いてない。
+ファイルを消す方法を知った後で「README.md」を指定して実行する必要がある。
+* そういえば先日「らくらくホン」画面上の鬱陶しい「羊」を消す方法が全くわからなかったのだが、あれは「マチキャラ」と呼ばれるものなので「マチキャラ」を消すという操作が必要だった。「羊 消す」とか「消す」とかで消せるべきだろう。githelpでは ```$ githelp 削除``` と入力すれば削除関連で何ができるのかわかる。
+* ヘルプといえば人工知能的なアプローチの方がトレンドかもしれないが、
+本方式だと
+自分が何をやりたいのかはっきりわかってない場合でも使えるし、
+正しいセンテンスを正確に入力したり発声したりする必要がないから楽だと思う。
+予測入力に近いといえるかもしれない。
+* **Gitは単なる適用例であり、広い範囲で使いたいと思っている。**
+
+
 ### お願い
 
-データが全然足りないので、こういうのを足せという情報があればお願いいたします。
+* [データ](https://github.com/masui/GitHelp/tree/master/data)が全然足りないので、足すべきデータを教えて下さい。
+issueでもプルリクでも@masuiへのツイートでもいいです。
+
+### 注意
+
+* Gitリポジトリのディレクトリで実行して下さい
+* [re_expand](https://github.com/masui/expand_ruby)の実装が富豪的なので大きなリポジトリだと不具合があるかもしれません
+
+### 関連システム
 
-### 考察とか
+* [AnyCode](http://dl.acm.org/citation.cfm?id=2814295)
 
-* Siriみたいなのでやるのがトレンドな気もするが、自分が何をやりたいのかはっきりわかってない場合でも使えるし、正しいセンテンスを指定する必要もないから楽だと思う
-  * ```githelp 削除``` とか言えば何ができるのかわかる
-* もちろんこのやり方はGit以外でも有効である
+  * 自然言語キーワードからJavaスニペットを検索する
+  * ```copy fileA fileB``` みたいなキーワードから ```FileUtil.copyFile(new File(fileA), new File(fileB))``` みたいなコード候補を生成する

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "githelp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/cat-file.rb

@@ -12,4 +12,8 @@
     "(#{numbers.join('|')})日前の「(#{files.join('|')})」ファイルを(表示する|見る)",
     'git cat-file -p "@{#{$1} days ago}":#{$2}'
   ],
+  [
+    "昨日の「(#{files.join('|')})」ファイルを(表示する|見る)",
+    'git cat-file -p "@{yesterday}":#{$1}'
+  ],
 ]

data/data/checkout.rb

@@ -14,7 +14,7 @@
   ],
   [
     "(#{numbers.join('|')})時間前の状態に一時的に戻す",
-    'git checkout "@{#{$1} hour ago}"'
+    'git checkout "@{#{$1} hours ago}"'
   ],
   [
     "(#{numbers.join('|')})日前の状態に一時的に戻す",

data/exe/githelp

@@ -10,8 +10,8 @@
 
 # 追加すべきデータはdata.txtに書く
 
-require "bundler/setup"
 require "githelp"
+require "bundler/setup"
 
 include Githelp
 
@@ -51,6 +51,7 @@ ARGV.dup.each { |arg|
 list = githelp(" #{args.join(' ')} ")
 if opt_x then
   cmd = list[opt_x][1]
+  STDERR.puts cmd
   system "PATH=$PATH:#{progdir}/bin; (#{cmd})"
   exit
 else
@@ -70,7 +71,7 @@ if opt_i then
       i = s.to_i
       if i >= 0 && i < list.length then
         cmd = list[i][1]
-        puts cmd
+        STDERR.puts cmd
         system "PATH=$PATH:#{progdir}/bin; (#{cmd})"
       end
     end

data/lib/githelp/version.rb

@@ -1,3 +1,3 @@
 module Githelp
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/githelp.rb

@@ -48,45 +48,4 @@ module Githelp
   end
 end
 
-# require 're_expand'
-# 
-# $libdir = File.dirname(__FILE__)
-# require "#{$libdir}/files"
-# require "#{$libdir}/args"
-# require "#{$libdir}/params"
-# require "#{$libdir}/patterns"
-# require "#{$libdir}/tags"
-# require "#{$libdir}/numbers"
-# require "#{$libdir}/branches"
-# require "#{$libdir}/changes"
-# require "#{$libdir}/glossary"
-# 
-# #
-# # パタンを指定してコマンド候補リストを得る
-# #
-# def githelp(pat)
-#   datadir = "#{$libdir}/../data"
-# 
-#   entries = []
-#   Dir.open(datadir).each { |file|
-#     next unless File.file?("#{datadir}/#{file}")
-#     next if file !~ /\.rb$/
-#     a = eval File.read("#{datadir}/#{file}")
-#     entries += a if a
-#   }
-# 
-#   g = ExpandRuby::Generator.new # re_expandのジェネレータ
-#   entries.each { |entry|
-#     g.add entry[0], entry[1] if entry
-#   }
-#   res = g.generate pat
-#   listed = {}
-#   res[0].find_all { |a| # 0 ambig
-#     if listed[a[1]]
-#       false
-#     else
-#       listed[a[1]] = true
-#     end
-#   }
-# end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: githelp
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Toshiyuki Masui
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,10 +80,10 @@ files:
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
-- Makefile
-- README-gem.md
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - data.txt
 - data/adddelete.rb
 - data/afteradd.rb

data/Makefile

@@ -1,6 +0,0 @@
-.PHONY: test
-test:
-	cd test; make
-install:
-	bundle install
-

data/README-gem.md

@@ -1,41 +0,0 @@
-# Githelp
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/githelp`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'githelp'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install githelp
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/githelp.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-