githelp 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b44761785f5b8f6abed97dd864aea2e911e5f0d5
-  data.tar.gz: b6c93ae5afa51e4c494889b34972b4c3e4925a91
+SHA256:
+  metadata.gz: cd3d9d689ca50ef940e6237b2d1327b3b6b551688eacd89f231d63a3eb83b5c5
+  data.tar.gz: 9199227423e521c9aa91affae0bc859a0a4e3a10ed5fe9962577292603d302c5
 SHA512:
-  metadata.gz: adea99c99d34a612f79debe607244654dea9cb109a0a4a417b263cde33c40d0d3f63aa892ee5a5e151f94907cd1f9907db163c7d1180dfbdbc2020a468cff2ab
-  data.tar.gz: d850c7a51e1088e84fce305ba7ea7f1a12c9f4763bffd7a08d436b26659a3a6f6c16a2415e41047d2306532675345ef57b8d8525537a3bb4c3dd1a507fd6d7b4
+  metadata.gz: 56b47dc7fc76a995d438324ea731abd061fd0145d9a02cf93895414868689409561bd1ea814b18bd4be8b57518470646e73d9fb8cbfdea431a86c373d8820953
+  data.tar.gz: 5d9f7a365fdb10f9f111503a5ef12d386429014ee2b40ad70b0c341847bb91575682c6c7f973f6cd746de474f14cd27928b32bc2724d71b5378aa57a5c106a54

data/.config/peco/config.json

@@ -0,0 +1,6 @@
+{
+    "Style": {
+	"Selected": ["on_cyan", "black"],
+	"Matched": ["blue", "on_blue"]
+    }
+}

data/00README

@@ -0,0 +1,8 @@
+* eval `githelp $* | peco` で実行
+  pecoで選択した行を実行する
+  ~/bin/gh あたりに置いておく
+
+* bin/gh => ~/bin/gh
+  .config/peco/config.json => ~/.config/peco/config.json
+
+

data/Gemfile

@@ -1,6 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in githelp.gemspec
-gemspec
+ruby '2.5.0'
 
+gem 're_expand'
 

data/Makefile

@@ -0,0 +1,10 @@
+data:
+	ruby getdata
+
+install:
+	bundle install
+	-mkdir ~/.config
+	-mkdir ~/.config/peco
+	cp .config/peco/config.json ~/.config/peco/config.json
+	-mkdir ~/bin
+	cp bin/gh ~/bin/gh

data/README.md

@@ -1,125 +1,12 @@
-# GitHelp
+<h1>GitHelp</h1>
 
-**Gitのコマンドの使いこなしを支援**
+<ul>
+  <li>古いものは<a href="https://github.com/masui/GitHelp_old">こちら</a></li>
+</ul>
 
-### 概要
+<h2>使いかた</h2>
 
-Gitのような複雑なシステムは使い方がわからなくて苦労する。
-ある程度使い方を知っている場合でも
-あまり標準的でない操作は難しい。
-たとえば以下のような場合は
-どういうコマンドを使えばいいだろうか?
-
-* 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)で解決する。***
-
-### 利用例
-
-Gitに関連するタスクのキーワードやパラメタを指定すると
-候補のリストが表示され、選択すると実行される。
-
-* ```README``` ```8``` ```比較``` のような引数を指定して```githelp```コマンドを起動すると以下のような候補リストが提示される
-
-```
-$ githelp README 8 比較
-[0] 「README.md」ファイルを8分前のものと比較する
-   % git diff HEAD "@{8 minutes ago}" README.md
-[1] 「README.md」ファイルを8時間前のものと比較する
-   % git diff HEAD "@{8 hours ago}" README.md
-[2] 「README.md」ファイルを8日前のものと比較する
-   % git diff HEAD "@{8 days ago}" README.md
-$
-```
-
-* ```-x``` オプションで```2```のような数字を指定すると実行できる
-
-
-```
-$ githelp README 8 比較 -x2
-diff --git a/README.md b/README.md
-index 862f185..34c8907 100644
---- a/README.md
-+++ b/README.md
-@@ -1,90 +1,3 @@
- # GitHelp
- 
--**Gitのコマンドの使いこなしを支援する**
--
--### 解決したい問題
-...
-```
-
-* ```-i``` オプションを指定すると対話的に選択できる
-
-### インストール
-
-```
-% gem install githelp
-```
-
-### 実装
-
-* [re_expand](https://github.com/masui/expand_ruby)
-という正規表現展開ライブラリを利用
-* [```data```](https://github.com/masui/GitHelp/tree/master/data)ディレクトリの下に**問題パタン**と**解決コマンド**を並べたものを用意しておく
-
-```
-[
-  "「(#{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)
-
-  * 自然言語キーワードからJavaスニペットを検索する
-  * ```copy fileA fileB``` みたいなキーワードから ```FileUtil.copyFile(new File(fileA), new File(fileB))``` みたいなコード候補を生成する
+<ul>
+  <li><code>% githelp キーワード</code></li>
+  <li><code>gh</code>を使うのがおすすめ (<code>peco</code>が必要)</li>
+</ul>

data/bin/gh

@@ -0,0 +1,2 @@
+#!/bin/bash
+eval `githelp $* | peco`

data/exe/getghdata

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+require 'net/https'
+require 'json'
+require 'uri'
+require 'cgi'
+require 'json'
+
+class GitHelp
+  DATAFILE = File.expand_path("~/.githelp")
+  
+  def initialize
+    @pagedata = {}
+  end
+  
+  # ページタイトルのリストを取得
+  def gettitles
+    uri = URI.parse("https://scrapbox.io/api/pages/GitHelp")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    req = Net::HTTP::Get.new(uri.path)
+    res = http.request(req)
+    JSON.parse(res.body)['pages'].collect { |page|
+      page['title']
+    }
+  end
+
+  # それぞれのページに対して処理
+  def getpage(title)
+    puts title
+    uri = URI.parse("https://scrapbox.io/api/pages/GitHelp/#{URI.encode(title).gsub(/\//,'%2f')}/text") # a/b みたいなタイトルのとき困る
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    req = Net::HTTP::Get.new(uri.path)
+    res = http.request(req)
+    text = res.body
+    text.force_encoding("utf-8")
+    # puts text
+    # @pagedata[title] = CGI.unescape(text).split(/\n/)
+    @pagedata[title] = text.split(/\n/)
+  end
+
+  def process
+    #
+    # ページデータ取得
+    #
+    gettitles.each { |title|
+      getpage title
+    }
+
+    dumpdata = {}
+    dumpdata['codes'] = []
+    dumpdata['defs'] = []
+    
+    #
+    # 関数/定数を評価"
+    #
+    puts "-----------------関数/定数を取得"
+    @pagedata.each { |title,pagedata|
+      puts title
+      pagedata. each { |line|
+        if line =~ /code:(.*)\.rb$/ then
+          puts "==========="
+          uri = URI.parse("https://scrapbox.io/api/code/GitHelp/#{URI.encode(title)}/#{$1}.rb")
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          req = Net::HTTP::Get.new(uri.path)
+          res = http.request(req)
+          # puts CGI.unescape(res.body)
+          text = res.body
+          text.force_encoding('utf-8')
+          dumpdata['codes'] << text
+        end
+      }
+    }
+    puts "-----------------GitHelpデータを検出"
+    @pagedata.each { |title,pagedata|
+      puts "...#{title}"
+      pagedata.each { |line|
+        puts line
+        if line =~ /^\s*[\$\%]/
+          puts line
+          line.force_encoding("utf-8")
+          dumpdata['defs'] << line
+        end
+      }
+    }
+    
+    File.open(DATAFILE,"w"){ |f|
+      f.puts dumpdata.to_json
+    }
+  end
+end
+
+githelp = GitHelp.new
+githelp.process

data/exe/githelp

@@ -1,79 +1,54 @@
 #!/usr/bin/env ruby
-# coding: utf-8
-#
-# GitHelp: ExpandHelpでGitを使いこなす
-#
-# % githelp                         # usage
-# % githelp README 8時間 比較       # マッチする候補を表示
-# % githelp -i README 8時間 比較    # マッチする候補を表示して選択
-#
 
-# 追加すべきデータはdata.txtに書く
+include Githelp
 
-require "githelp"
-require "bundler/setup"
+require 're_expand'
+require 'json'
 
-include Githelp
+DATAFILE = File.expand_path("~/.githelp")
 
-unless git_check
-  STDERR.puts "Use 'githelp' in a Git repository."
-  exit
-end
+data = JSON.parse(File.read(DATAFILE))
 
-progpath = $0
-if File.symlink?(progpath)
-  progpath = File.readlink(progpath)
-end
-progdir = "#{File.dirname(progpath)}"
+#
+# 関数定義などをeval
+#
+data['codes'].each { |code|
+  eval code
+}
 
-opt_i = false
-opt_x = nil
-i = 0
-ARGV.dup.each { |arg|
-  if arg == "-i"
-    opt_i = true
-    ARGV.delete_at(i)
-  elsif opt_x == ''
-    opt_x = arg.to_i
-    ARGV.delete_at(i)
-  elsif arg =~ /^-x(\d*)/
-    if $1.to_s != ''
-      opt_x = $1.to_i
-    else
-      opt_x = ''
-    end
-    ARGV.delete_at(i)
-  else
-    i += 1
+g = ExpandRuby::Generator.new # re_expandのジェネレータ
+
+#
+# GitHelpエントリ
+#
+lines = []
+
+data['defs'].each { |line|
+  if line =~ /^\s*\$\s*(.*)$/ # $....
+    lines << $1
+  elsif line =~ /^\s*\%\s*(.*)$/ # %....
+    cmd = $1
+    lines.each { |l|
+      desc = eval('"' + l + '"')
+      g.add desc.force_encoding('utf-8'), cmd.force_encoding('utf-8')
+    }
+    lines = []
   end
 }
 
-list = githelp(" #{args.join(' ')} ")
-if opt_x then
-  cmd = list[opt_x][1]
-  STDERR.puts cmd
-  system "PATH=$PATH:#{progdir}/bin; (#{cmd})"
-  exit
-else
-  IO.popen("more","w"){ |f|
-    list.each_with_index { |entry,ind|
-      f.puts "[#{ind}] #{entry[0]}"
-      f.puts "   % " + entry[1]
-    }
-  }
-end
+res = g.generate " #{args.join(' ')} "
 
-if opt_i then
-  if list.length > 0 then
-    print "実行するコマンドの番号を入力して下さい > "
-    s = STDIN.readline
-    if s =~ /[0-9]/ then
-      i = s.to_i
-      if i >= 0 && i < list.length then
-        cmd = list[i][1]
-        STDERR.puts cmd
-        system "PATH=$PATH:#{progdir}/bin; (#{cmd})"
-      end
-    end
+listed = {}
+list = res[0].find_all { |a| # 0 ambig
+  if listed[a[1]]
+    false
+  else
+    listed[a[1]] = true
   end
-end
+}
+
+list.each_with_index { |entry,ind|
+  puts "#[#{ind}] #{entry[0]}"
+  puts "   #{entry[1]}"
+}
+

data/getdata

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+require 'net/https'
+require 'json'
+require 'uri'
+require 'cgi'
+require 'json'
+
+class GitHelp
+  DATAFILE = File.expand_path("~/.githelp")
+  
+  def initialize
+    @pagedata = {}
+  end
+  
+  # ページタイトルのリストを取得
+  def gettitles
+    uri = URI.parse("https://scrapbox.io/api/pages/GitHelp")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    req = Net::HTTP::Get.new(uri.path)
+    res = http.request(req)
+    JSON.parse(res.body)['pages'].collect { |page|
+      page['title']
+    }
+  end
+
+  # それぞれのページに対して処理
+  def getpage(title)
+    puts title
+    uri = URI.parse("https://scrapbox.io/api/pages/GitHelp/#{URI.encode(title).gsub(/\//,'%2f')}/text") # a/b みたいなタイトルのとき困る
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    req = Net::HTTP::Get.new(uri.path)
+    res = http.request(req)
+    text = res.body
+    text.force_encoding("utf-8")
+    # puts text
+    # @pagedata[title] = CGI.unescape(text).split(/\n/)
+    @pagedata[title] = text.split(/\n/)
+  end
+
+  def process
+    #
+    # ページデータ取得
+    #
+    gettitles.each { |title|
+      getpage title
+    }
+
+    dumpdata = {}
+    dumpdata['codes'] = []
+    dumpdata['defs'] = []
+    
+    #
+    # 関数/定数を評価"
+    #
+    puts "-----------------関数/定数を取得"
+    @pagedata.each { |title,pagedata|
+      puts title
+      pagedata. each { |line|
+        if line =~ /code:(.*)\.rb$/ then
+          puts "==========="
+          uri = URI.parse("https://scrapbox.io/api/code/GitHelp/#{URI.encode(title)}/#{$1}.rb")
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          req = Net::HTTP::Get.new(uri.path)
+          res = http.request(req)
+          # puts CGI.unescape(res.body)
+          text = res.body
+          text.force_encoding('utf-8')
+          dumpdata['codes'] << text
+        end
+      }
+    }
+    puts "-----------------GitHelpデータを検出"
+    @pagedata.each { |title,pagedata|
+      puts "...#{title}"
+      pagedata.each { |line|
+        puts line
+        if line =~ /^\s*[\$\%]/
+          puts line
+          line.force_encoding("utf-8")
+          dumpdata['defs'] << line
+        end
+      }
+    }
+    
+    File.open(DATAFILE,"w"){ |f|
+      f.puts dumpdata.to_json
+    }
+  end
+end
+
+githelp = GitHelp.new
+githelp.process