RubyGems - helpline - Versions diffs - 0.1.14 → 0.2.1 - Mend

helpline 0.1.14 → 0.2.1

Files changed (15) hide show

data/Makefile CHANGED

@@ -1,53 +1,17 @@
-.PHONY: data.js glossary.js
-run: browserify
-	npm start .
-browserify:
-	browserify helpline.js -o helpline_browserify.js
-build-mac: install browserify
-	npm run build
-	cp -r build/mac/HelpLine.app /Applications
-upload:
-	scp build/HelpLine-0.0.1.dmg pitecan.com:/www/www.pitecan.com/tmp/HelpLine.dmg
-build-chromebook: browserify install
-	npm run build
-#dmg: build-mac
-#	-/bin/rm -f HelpLine.dmg
-#	hdiutil create -srcfolder build/mac/HelpLine.app -volname HelpLine HelpLine.dmg
-#install: npm browserify cursorpos electron
-install:
-	npm install
-electron:
-	npm install electron
 #
-# Scrapboxからデータ更新
-#
-update: data.js glossary.js
-data.js:
-	ruby getdata.rb > data.js
-glossary.js:
-	ruby getglossary.rb > glossary.js
-clean:
-	-/bin/rm -r -f node_modules
-	-/bin/rm -r -f build
-	-/bin/rm -f HelpLine.dmg
-all: update build-mac
-#
-# gem
+# Gem版
 #
 release:
 	rake release
+update:
+	helpline --update
+update-local:
+	helpline --update --debug --source ~/ScrapboxData/HelpLine.json,~/ScrapboxData/masui-helpline.json
+#
+# テスト
+#
+test:
+	ruby test/test.rb

data/Makefile.electron ADDED

@@ -0,0 +1,43 @@
+.PHONY: data.js glossary.js test
+run: browserify
+	npm start .
+browserify:
+	browserify helpline.js -o helpline_browserify.js
+build-mac: install browserify
+	npm run build
+	cp -r build/mac/HelpLine.app /Applications
+upload:
+	scp build/HelpLine-0.0.1.dmg pitecan.com:/www/www.pitecan.com/tmp/HelpLine.dmg
+build-chromebook: browserify install
+	npm run build
+#dmg: build-mac
+#	-/bin/rm -f HelpLine.dmg
+#	hdiutil create -srcfolder build/mac/HelpLine.app -volname HelpLine HelpLine.dmg
+#install: npm browserify cursorpos electron
+install:
+	npm install
+electron:
+	npm install electron
+#
+# Scrapboxからデータ更新
+#
+update: data.js glossary.js
+data.js:
+	ruby getdata.rb > data.js
+glossary.js:
+	ruby getglossary.rb > glossary.js
+clean:
+	-/bin/rm -r -f node_modules
+	-/bin/rm -r -f build
+	-/bin/rm -f HelpLine.dmg
+all: update build-mac

data/exe/helpline CHANGED

@@ -1,261 +1,40 @@
 #!/usr/bin/env ruby
 # -*- ruby -*-
-require 'json'
 require 'optparse'
-require 'scrapbox'
-require 're_expand'
+$:.unshift "lib"
+require 'helpline/helpline'
+require 'helpline/update'
+require 'helpline/generate'
+require 'helpline/run'
-require 'io/console'
-require 'helpline/curses'
+# アップデート
+#   % helpline -u
+# データを指定してアップデート
+#   % helpline -u HelpLine /Users/masui/ScrapboxData/masui-HelpLine.json
+# テスト
+#   % helpline -t args
+#
-puts
-class HelpLine
-  LINES = 12
-  def datafile
-    File.expand_path("~/.helpline.json")
-  end
-  def initialize
-    @pagedata = {}
-    @project = Scrapbox::Project.new("HelpLine")
-  end
-  def getdata
-    #
-    # ページデータ取得
-    #
-    puts "-----------------ページデータを取得"
-    @project.pages.each { |title,page|
-      puts "...#{title}"
-      @pagedata[title] = page.text.split(/\n/)
-    }
-    dumpdata = {}
-    dumpdata['codes'] = []
-    dumpdata['defs'] = []
-    dumpdata['pages'] = []
-    #
-    # 関数/定数を評価"
-    #
-    puts "-----------------関数/定数を取得"
-    @pagedata.each { |title,pagedata|
-      puts "...#{title}"
-      pagedata. each { |line|
-        if line =~ /code:(.*\.rb)$/ then
-          src = $1
-          puts "=========== #{src}"
-          page = Scrapbox::Page.new(@project,title)
-          dumpdata['codes'] << page.code(src)
-        end
-      }
-    }
-    puts "-----------------HelpLineデータを検出"
-    @pagedata.each { |title,pagedata|
-      puts "...#{title}"
-      dumpdata['pages'] << title
-      processing_defs = false
-      codeindent = nil
-      pagedata.each { |line|
-        if !codeindent
-          if line =~ /^(\s*)code:/
-            codeindent = $1.length
-            next
-          end
-        else
-          line =~ /^(\s*)/
-          if line.length < codeindent
-            codeindent = nil
-          else
-            next
-          end
-        end
-        if line =~ /^\s*[\$\%]/
-          puts line
-          if line =~ /^\%/ && !processing_defs
-            puts "'$'で始まる用例定義なしでコマンドを定義しようとしています"
-            exit
-          end
-          dumpdata['defs'] << "#{line} {#{dumpdata['pages'].length-1}}"
-          processing_defs = true
-        else
-          processing_defs = false
-        end
-      }
-    }
-    File.open(datafile,"w"){ |f|
-      f.puts dumpdata.to_json
-    }
-  end
-  def disp(list,sel)
-    Curses.move(0,0)
-    lines = list.length
-    lines = LINES if lines > LINES
-    (0...lines).each { |i|
-      Curses.move(i,0)
-      s = "* #{list[i][0]}"
-      if i == sel
-        Curses.print_inverse s
-      else
-        Curses.print s
-      end
-    }
-    Curses.move(sel,0)
-    # Curses.down
-    # Curses.tol
-  end
-  def helpline
-    data = JSON.parse(File.read(datafile))
-    unless data['pages'] # データ型式変換があったので
-      getdata
-      data = JSON.parse(File.read(datafile))
-    end
-    #
-    # 関数定義などをeval
-    #
-    data['codes'].each { |code|
-      eval code
-    }
-    g = ExpandRuby::Generator.new # re_expandのジェネレータ
-    #
-    # HelpLineエントリ
-    #
-    entries = []
-    data['defs'].each { |line|
-      if line =~ /^\s*\$\s*(.*)$/ # $....
-        entries << $1
-      elsif line =~ /^\s*\%\s*(.*)$/ # %....
-        cmd = $1
-        entries.each { |l|
-          desc = eval('"' + l + '"')
-          g.add desc.force_encoding('utf-8'), cmd.force_encoding('utf-8')
-        }
-        entries = []
-      end
-    }
-    res = g.generate " #{ARGV.join(' ').sub(/\[/,'').sub(/\]/,'')} "
-    File.open("/tmp/helpline.cmd","w"){ |f|
-      f.puts ARGV.join(' ')
-    }
-    if res[0].length == 0
-      puts "ヘルプがみつかりません"
-      exit
-    end
-    git_repository = File.exist?(".git")
-    listed = {}
-    list = res[0].find_all { |a| # 0 ambig
-      # a = ["現在の状況を表示する {56}", "git status {56}"], etc.
-      if a[0] =~ /voidvoidvoid/
-        false
-      elsif a[0] =~ /^git:/ && !git_repository
-        false
-      else
-        if listed[a[1]]
-          false
-        else
-          listed[a[1]] = true
-        end
-      end
-    }
-    #
-    # HelpLineメニュー表示し、カーソル移動で選択
-    #
-    help_number = {}
-    list.each_with_index { |entry,ind|
-      entry[0].sub!(/\s*{(\d*)}$/,'')
-      entry[1].sub!(/\s*{(\d*)}$/,'')
-      help_number[entry[0]] = $1.to_i
-    }
-    sel = 0
-    disp(list,sel)
-    lines = list.length
-    lines = LINES if lines > LINES
-    inputchars = ''
-    while true
-      c = STDIN.getch
-      inputchars += c
-      if inputchars == "\e"
-      # process ESC
-      elsif inputchars[0] == "\e" && inputchars.length == 2
-      # 何もしない
-      elsif inputchars == "\x06" || inputchars == "\e[C" || inputchars == "\eOC"
-        #  Curses.right
-        inputchars = ''
-      elsif inputchars == "\x02" || inputchars == "\e[D" || inputchars == "\eOD"
-        #  Curses.left
-        inputchars = ''
-      elsif inputchars == "\x0e" || inputchars == "\e[B" || inputchars == "\eOB"
-        Curses.down
-        sel = (sel + 1) if sel < lines-1
-        inputchars = ''
-      elsif inputchars == "\x10" || inputchars == "\e[A" || inputchars == "\eOA"
-        Curses.up
-        sel = sel - 1 if sel > 0
-        inputchars = ''
-      else
-        inputchars = ''
-      end
-      STDIN.flush
-      disp(list,sel)
-      exit if c== 'q' || c == "\x03"
-      if c == "\r" || c == "\n"
-        break
-      end
-    end
-    desc = list[sel.to_i][0]
-    cmd = list[sel][1]
+helpline = HelpLine.new
-    Curses.move(lines,0)
-    Curses.tol
+options = ARGV.getopts('utds:','update','test','source:','debug')
-    #Curses.move(0,0)
-    ##Curses.down
-    Curses.print_inverse("「#{desc}」を実行")
-    puts " (ソース: http://scrapbox.io/HelpLine/#{data['pages'][help_number[desc]]})"
-    File.open("/tmp/helpline.cmd","w"){ |f|
-      f.puts cmd
-    }
-  end
+#
+# update
+#
+if options['u'] || options['update'] # ~/.helpline.json更新
+  sources = (ARGV.length > 0 ? ARGV : ['HelpLine'])
+  helpline.update sources
+  exit
 end
-# is_repository = system 'git rev-parse --git-dir > /dev/null >& /dev/null'
-# unless is_repository
-#   STDERR.puts "Gitレポジトリで実行して下さい"
-#   exit
-# end
-options = ARGV.getopts('u')
-helpline = HelpLine.new
-if !File.exist?(helpline.datafile) && !options['u']
-  puts "#{helpline.datafile}を作成します..."
-  helpline.getdata
-end
-if options['u'] then
-  helpline.getdata
-else
-  helpline.helpline
+if options['t'] || options['test'] # テスト
+  puts helpline.generate " #{ARGV.join(' ')} "
+  exit
 end
+debug = options['d'] || options['debug']
+query = " #{ARGV.join(' ').sub(/\[/,'').sub(/\]/,'')} "
+helpline.run query, debug

data/index.html CHANGED

@@ -20,16 +20,13 @@
     <section class="main-content">
       <center>
-	<video src="https://s3-ap-northeast-1.amazonaws.com/masui.org/d/b/db555e8535ff111e794b95e6d3d7a8f5.mp4" width=600 controls></video>
+	<video src="https://s3-ap-northeast-1.amazonaws.com/masui.org/b/9/b9b2ae65a3a977857b5487f280785b47.mp4" width=600 controls></video>
       </center>
-      <p>
-	以下、GitHelpのテキストをコピペしただけなのでHelpLineの説明になってません。すみません
-      </p>
-      <p>
-      　Gitのような複雑なシステムは使い方が難しい。
-      ある程度使い方を知っている場合でも、あまり一般的でない機能を使うのは難しい。
+      <p></p>
+      　コマンドラインのオプションは難しいものが多い。
+      Gitのような複雑なシステムの場合、概念もオプションも難しい。
       たとえば以下のような場合はどういうコマンドを使えばいいだろうか?
       </p>
@@ -170,19 +167,19 @@
 	誰でも情報を足したり修正したりできたら嬉しいだろう。
       </p>
-      <h3>GitHelpのアプローチ</h3>
+      <h3>HelpLineのアプローチ</h3>
       <p>
-	　GitHelpは、以下のような方針で上のような課題をすべて解決しようというものである。
+	　HelpLineは、以下のような方針で上のような課題をすべて解決しようというものである。
 	<ul>
 	  <li>ユーザのあらゆる曖昧な表現にマッチするようにヘルプ文字列を正規表現で表現し、
-	    Gitコマンドに変換する</li>
+	    コマンドに変換する</li>
 	  - ExpandHelp(<a href="https://github.com/masui/expand-ruby">ソース</a> /
 	  <a href="http://www.interaction-ipsj.org/archives/paper2012/data/Interaction2012/oral/data/pdf/12INT012.pdf">論文</a>)を利用
 	  <li>データをすべてクラウド上に置いて編集可能にすることにより、
 	    誰でもデータを追加/修正できるようにする</li>
-	  - <a href="https://Scrapbox.io/GitHelp">Scrapbox</a>を利用
+	  - <a href="https://Scrapbox.io/HelpLine">Scrapbox</a>を利用
 	  <li>ユーザが指定したパラメタはそのまま利用して実行に使う</li>
 	  -  ユーザが「4」「時間」などと指定すると「時刻を4時にセットする」のようなものを提案して実行可能にする
 	  <li>多少の誤入力を許す</li>
@@ -193,43 +190,48 @@
       <h3>利用例</h3>
-      Gitに関連するタスクのキーワードやパラメタを指定して
-      <code>githelp</code>を起動すると
-      候補のリストが表示され、
+      タスクのキーワードやパラメタを指定してCtrl-Jを押すと
+      <code>helpline</code>が起動して候補のリストが表示され、
       カーソルで選択すると実行される。
       <ul>
-	<li><code>$ githelp 2 README</code>のように引数を指定して起動すると以下のような候補リストが提示される</li>
-	<img src="https://gyazo.com/6cc87cef5f28185199074b61716454de.png" width=500>
+	<li><code>$ 2 README</code>と入力してからCtrl-Jを押すと
+	  以下のような候補リストが提示される</li>
+	<img src="https://gyazo.com/806cb4c2c14781465949ec3aa85d563b.png" width=500>
 	<p></p>
 	<li>カーソルで選択してリターンを押すと実行される</li>
-	<img src="https://gyazo.com/75c14885944c33f2671474b008120262.png" width=500>
+	<img src="https://gyazo.com/b72f97a2664d504c5465fd11bac92184.png" width=700>
       </ul>
       <a name="install"><h3>インストール</h3></a>
-      <pre>
-	% gem install githelp   </pre>
       <ul>
-	<li>対話的処理のために<a href="https://github.com/peco/peco">peco</a>が必要</li>
-	<ul>
-	  <li>Macだと<code>% brew install peco</code>でインストール可能</li>
-	  <li>Linuxなどの場合<a href="https://github.com/peco/peco/releases">こちら</a>のファイルからインストール (yumなどでは入らない)</li>
-	</ul>
+	<li> <code>gem</code>でHelpLineをインストール
+	  <pre>
+% gem install helpline</pre>
+	</li>
+	<li> <code>~/.zshrc</code>に以下の記述を追加
+	  <pre>
+function run-help() {
+   helpline "${BUFFER}" < $TTY
+   BUFFER=$(cat /tmp/helpline.cmd)
+   CURSOR=${#BUFFER}
+   zle redisplay
+}
+zle -N run-help
+bindkey "^j" run-help</pre>
+        </li>
       </ul>
       <h3>実装</h3>
       <ul>
 	<li><a href="https://github.com/masui/expand_ruby">re_expand</a>
 	  という正規表現展開ライブラリを利用</li>
 	<li><a href="https://Scrapbox.io/GitHelp">Scrapbox</a>にあらゆる情報を書いておく</li>
 	<br>
-	<img src="https://gyazo.com/b4ba42a96617c65db32020eb1ea19bf3.png" width=450>
+	<img src="https://gyazo.com/cd1529fe082c57d4295e8660ba3cb932.png" width=550>
 	<li>
 	  様々なタスクの説明と実際の操作を組にして記述しておき、
 	  ユーザが与えたキーワードやパラメタにマッチするものを
@@ -259,23 +261,11 @@
 	  翻訳作業があまり気にならないものなのかもしれないが、
 	  そういう「翻訳」は少ない方が良いのは確かだろう。
 	</li>
-	<li>そういえば先日「らくらくホン」画面に出てくる鬱陶しい「羊」を消す方法が全くわからなかったのだが、
-	  あれは「マチキャラ」と呼ばれるものなので
-	  「マチキャラ」を消すという操作が必要だった。
-	  お前はMSのイルカか。
-	  「羊 消す」とか「消す」とかで消せるべきだろう。
-	  githelpでは <code>$ githelp 削除</code> と入力すれば削除関連で何ができるのかわかるだろうし、
-	  <code>(鬱陶しい|不快な)羊を(消す|殺す)</code>
-	  のようなエントリをユーザが足すこともできるだろう。
-	</li>
-	<img src="http://service.smt.docomo.ne.jp/site/iconcier/img/iconcier_ptl_cha_img01.png" width=300>
-	<li>というわけで<b>Gitは単なる適用例であり、広い範囲で使いたいと思っている。</b></li>
       </ul>
       <h3> 注意</h3>
       <ul>
-	<li><code>githelp</code>コマンドはGitリポジトリのディレクトリで実行する必要がある</li>
 	<li><a href="https://github.com/masui/expand_ruby">re_expand</a>の実装が富豪的なので
 	  大きなリポジトリだと不具合があるかも</li>
 	<li>データが全然足りない... 特にリモートリポジトリ関連のデータは皆無だが、