textbringer 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9641c360dd5bb038429536d85e666ff3518e37413eeece13898fa1a730665193
-  data.tar.gz: e2e9f71f90e060e30aac0bfa273fe65349eacc633f83c7c6dda034aa160436c6
+  metadata.gz: 5e9f67d3a60acc75b16f9f5ede7d7670068590b2331aa905b73d9fe09676e305
+  data.tar.gz: 388e2c7cdecee2292ea17167810944f1ccfc2f7ed0dfb48db9732e31c71b5818
 SHA512:
-  metadata.gz: 285df14ab50ac3b27e5c61a3c24503c7ce724b84a918072ada9e920c323f94c46564b329a3217950bddeee5e1c4b5e83f426ad577bb8cb6596004c2b374fd12d
-  data.tar.gz: 6ed66854359cdd89310f77cb79c2b14cdafe4b5c7636aee662c7d1a4103563388e183bf11b5b7aab45fd691b70fa16c5d33f66231f109c6a733d05c98f1087e2
+  metadata.gz: f8973ef2ee4f24b829ebb505229ca45ee48a7f2d5fa21f20afb5bfce4c0b9df5333cbb5614ba1a48dcc1633e286edc2199d68b7fab347d090be94e43d376d205
+  data.tar.gz: e5847cd0e51bd26a8b4d38a5682ff9347d5886022e62b11a6e1b294dc78df455718e9be5319098050709545a98b75b41775db618562dd2bdee72a3e65baf91bd

data/.github/workflows/ubuntu.yml

@@ -6,7 +6,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [ head, 3.1, 3.0, 2.7, 2.6 ]
+        ruby: [ head, 3.1, 3.0, 2.7 ]
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:

data/.github/workflows/windows.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        ruby: [ 'mingw', 'mswin', '3.0', '2.7', '2.6' ]
+        ruby: [ 'mingw', 'mswin', '3.0', '2.7' ]
     timeout-minutes: 10
     steps:
     - uses: actions/checkout@v2

data/CHANGES.md

@@ -1,3 +1,16 @@
+## 1.3.0
+
+* Kernel#print etc. inserts the given string into the current buffer now.
+* Add find_source.
+* Add describe_class and describe_method.
+* Support completion for eval_expression
+* Fix digraph indentation in C mode.
+
+## 1.2.0
+
+* Drop Ruby 2.6 support.
+* Change the command name to `txtb`.
+
 ## 1.1.2
 
 * Buf fixes.

data/README.ja.md

@@ -0,0 +1,103 @@
+# ![Textbringer](logo/logo.png)
+
+[![Gem Version](https://badge.fury.io/rb/textbringer.svg)](https://badge.fury.io/rb/textbringer)
+[![ubuntu](https://github.com/shugo/textbringer/workflows/ubuntu/badge.svg)](https://github.com/shugo/textbringer/actions?query=workflow%3Aubuntu)
+[![windows](https://github.com/shugo/textbringer/workflows/windows/badge.svg)](https://github.com/shugo/textbringer/actions?query=workflow%3Awindows)
+[![macos](https://github.com/shugo/textbringer/workflows/macos/badge.svg)](https://github.com/shugo/textbringer/actions?query=workflow%3Amacos)
+
+TextbringerはRubyで実装されたEmacsライクなテキストエディタです。
+Lispの代りにRubyで拡張することができます。
+
+## スクリーンショット
+
+![Screenshot](screenshot.png)
+
+## デモ
+
+* FizzBuzz: https://asciinema.org/a/103357
+* Rubyプログラミング: https://asciinema.org/a/100156
+* 日本語テキストの編集: https://asciinema.org/a/100166
+
+## インストール
+
+    $ gem install textbringer
+
+マルチバイト文字を使用するためにはncurseswが必要です。
+Textbringerが依存するcurses.gemをインストールする前に、ncurseswをインストールしておいてください。
+
+    $ sudo apt-get install libncursesw5-dev
+    $ gem install curses
+
+## 使い方
+
+    $ txtb
+
+`Ctrl-x Ctrl-c` で終了できます。　
+
+多くのコマンドとキーバインディングは[Emacs](https://www.gnu.org/software/emacs/)に似ています。
+
+キーバインディングを確認するには、 `F1 b` または `Alt+x describe_bindings RET` とタイプしてください。
+
+## 設定
+
+### メタキー
+
+端末エミュレータでメタキーを使用するためには、以下のような設定が必要です。
+
+#### xterm
+
+~/.Xresourcesに以下の行を追加してください。
+
+    XTerm*metaSendsEscape: true
+
+#### mlterm
+
+~/.mlterm/mainに以下の行を追加してください。
+
+    mod_meta_key = alt
+    mod_meta_mode = esc
+
+### 東アジアの曖昧な文字幅
+
+[曖昧な文字](http://unicode.org/reports/tr11/#Ambiguous)を全角扱いするには、以下の設定を~/.textbringer.rbに記述してください。
+
+    CONFIG[:east_asian_ambiguous_width] = 2
+
+ncurseswはwcwidth(3)を使用するため、LD_PRELOADハックやlocale charmapの修正が必要かもしれません。
+
+* https://github.com/fumiyas/wcwidth-cjk
+* https://github.com/hamano/locale-eaw
+
+xterm、 mlterm、screenにはそれぞれ独自の設定項目があります。
+
+#### xterm
+
+~/.Xresourcesに以下の設定を追加してください。
+
+    xterm*utf8: 1
+    xterm*locale: true
+    xterm*cjkWidth: true
+
+#### mlterm
+
+~/.mlterm/mainに以下の設定を追加してください。
+
+    col_size_of_width_a = 2
+
+#### screen
+
+~/.screenrcに以下の設定を追加してください。
+
+    cjkwidth on
+
+## プラグイン
+
+* [Mournmamil](https://github.com/shugo/mournmail): 電子メールクライアント
+* [MedicineShield](https://github.com/shugo/medicine_shield): Mastodonクライアント
+* [textbringer-presentation](https://github.com/shugo/textbringer-presentation): プレゼンテーションツール
+* [textbringer-ghost_text](https://github.com/shugo/textbringer-ghost_text): [GhostText](https://github.com/fregante/GhostText)プラグイン
+
+## ライセンス
+
+[MIT License](http://opensource.org/licenses/MIT)の下でオープンソースとして利用可能です。
+

data/README.md

@@ -5,8 +5,10 @@
 [![windows](https://github.com/shugo/textbringer/workflows/windows/badge.svg)](https://github.com/shugo/textbringer/actions?query=workflow%3Awindows)
 [![macos](https://github.com/shugo/textbringer/workflows/macos/badge.svg)](https://github.com/shugo/textbringer/actions?query=workflow%3Amacos)
 
-Textbringer is a member of a demon race that takes on the form of an Emacs-like
-text editor.
+* [日本語版](README.ja.md)
+
+Textbringer is an Emacs-like text editor written in Ruby.
+It is extensible by Ruby instead of Lisp.
 
 ## Screenshot
 
@@ -30,7 +32,7 @@ Install ncursesw before installing curses.gem, on which textbringer depends.
 
 ## Usage
 
-    $ textbringer
+    $ txtb
 
 You can quit the editor by `Ctrl-x Ctrl-c`.
 
@@ -93,6 +95,13 @@ Add the following line to ~/.screenrc.
 
     cjkwidth on
 
+## Plugins
+
+* [Mournmamil](https://github.com/shugo/mournmail): a mail user agent
+* [MedicineShield](https://github.com/shugo/medicine_shield): a Mastodon client
+* [textbringer-presentation](https://github.com/shugo/textbringer-presentation): a presentation tool
+* [textbringer-ghost_text](https://github.com/shugo/textbringer-ghost_text): a [GhostText](https://github.com/fregante/GhostText) plugin
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/{textbringer → txtb}

@@ -19,13 +19,14 @@ def load_user_config(path)
 end
 
 unless STDIN.tty?
-  STDERR.puts("textbringer: standard input is not a tty")
+  STDERR.puts("txtb: standard input is not a tty")
   exit 1
 end
 
 Controller.current = Controller.new
 begin
   Window.start do
+    $stdout = DefaultOutput.new
     begin
       load_user_config("~/.textbringer/init.rb")
       Plugin.load_plugins

data/lib/textbringer/commands/files.rb

@@ -143,5 +143,20 @@ module Textbringer
                                  File.dirname(Buffer.current.file_name))|
       FileUtils.mkdir_p(dir_name)
     end
+
+    define_command(:find_source, doc: "Open the source file.") do
+      |obj = read_object("Object or Class: ")|
+      klass = obj.is_a?(Module) ? obj : obj.class
+      method_name = klass.instance_methods(false).first
+      if method_name.nil?
+        raise EditorError, "Source not found"
+      end
+      method = klass.instance_method(method_name)
+      file_name = method.source_location.first
+      if !File.exist?(file_name)
+        raise EditorError, "Source not found"
+      end
+      find_file(method.source_location.first)
+    end
   end
 end

data/lib/textbringer/commands/help.rb

@@ -1,3 +1,6 @@
+$".push("readline.rb")
+require "rdoc/ri/driver"
+
 module Textbringer
   module Commands
     HELP_RING = Ring.new
@@ -102,6 +105,44 @@ module Textbringer
       push_help_command([:describe_key, key])
     end
 
+    define_command(:describe_class,
+                   doc: "Display the documentation of the class.") do
+      |name = read_expression("Describe class: ")|
+      show_help do |help|
+        old_stdout = $stdout
+        $stdout = StringIO.new
+        begin
+          rdoc = RDoc::RI::Driver.new(use_stdout: true,
+                                      formatter: RDoc::Markup::ToRdoc,
+                                      interactive: false)
+          rdoc.display_class(name)
+          help.insert($stdout.string)
+        ensure
+          $stdout = old_stdout
+        end
+      end
+      push_help_command([:describe_class, name])
+    end
+
+    define_command(:describe_method,
+                   doc: "Display the documentation of the method.") do
+      |name = read_expression("Describe method: ")|
+      show_help do |help|
+        old_stdout = $stdout
+        $stdout = StringIO.new
+        begin
+          rdoc = RDoc::RI::Driver.new(use_stdout: true,
+                                      formatter: RDoc::Markup::ToRdoc,
+                                      interactive: false)
+          rdoc.display_method(name)
+          help.insert($stdout.string)
+        ensure
+          $stdout = old_stdout
+        end
+      end
+      push_help_command([:describe_method, name])
+    end
+
     define_command(:help_go_back, doc: "Go back to the previous help.") do
       if !HELP_RING.empty?
         HELP_RING.rotate(1)

data/lib/textbringer/commands/misc.rb

@@ -32,7 +32,7 @@ module Textbringer
     end
 
     define_command(:eval_expression) do
-      |s = read_from_minibuffer("Eval: ")|
+      |s = read_expression("Eval: ")|
       result = eval(s, TOPLEVEL_BINDING, "(eval_expression)", 1)
       message(result.inspect)
       result

data/lib/textbringer/default_output.rb

@@ -0,0 +1,18 @@
+require "stringio"
+
+module Textbringer
+  class DefaultOutput
+    def write(*args)
+      Buffer.current.insert(args.join)
+    end
+
+    def flush
+    end
+
+    def method_missing(mid, ...)
+      buffer = StringIO.new
+      buffer.send(mid, ...)
+      write(buffer.string)
+    end
+  end
+end

data/lib/textbringer/keymap.rb

@@ -210,6 +210,8 @@ module Textbringer
   GLOBAL_MAP.define_key([:f1, "b"], :describe_bindings)
   GLOBAL_MAP.define_key([:f1, "f"], :describe_command)
   GLOBAL_MAP.define_key([:f1, "k"], :describe_key)
+  GLOBAL_MAP.define_key([:f1, "c"], :describe_class)
+  GLOBAL_MAP.define_key([:f1, "m"], :describe_method)
   GLOBAL_MAP.define_key("\C-x#", :server_edit_done)
   GLOBAL_MAP.define_key("\C-\\", :toggle_input_method)
   GLOBAL_MAP.handle_undefined_key do |key|

data/lib/textbringer/modes/c_mode.rb

@@ -1,6 +1,6 @@
 module Textbringer
   CONFIG[:c_indent_level] = 4
-  CONFIG[:c_indent_tabs_mode] = true
+  CONFIG[:c_indent_tabs_mode] = false
   CONFIG[:c_continued_statement_offset] = 4
   CONFIG[:c_case_label_offset] = -4
   CONFIG[:c_label_offset] = -2
@@ -187,7 +187,7 @@ module Textbringer
         if text.empty?
           raise EditorError, "Empty token: (#{line},#{column}) #{$~.inspect}"
         end
-        tokens.push([[line, column], token_name, text])
+        tokens.push([[line, column], token_name, CANONICAL_PUNCTUATORS[text]])
         lf_count = text.count("\n")
         if lf_count > 0
           line += lf_count
@@ -269,7 +269,7 @@ module Textbringer
       end
     end
 
-    CANONICAL_PUNCTUATORS = Hash.new { |h, k| k }
+    CANONICAL_PUNCTUATORS = Hash.new { _2 }
     CANONICAL_PUNCTUATORS["<:"] = "["
     CANONICAL_PUNCTUATORS[":>"] = "]"
     CANONICAL_PUNCTUATORS["<%"] = "{"

data/lib/textbringer/utils.rb

@@ -1,4 +1,6 @@
 require "rbconfig"
+require "irb"
+require "irb/completion"
 
 module Textbringer
   module Utils
@@ -164,7 +166,7 @@ module Textbringer
         Window.echo_area.redisplay
         Window.update
         recursive_edit
-        s = Buffer.minibuffer.to_s.chomp
+        s = Buffer.minibuffer.to_s
         if default && s.empty?
           default
         else
@@ -323,6 +325,18 @@ module Textbringer
       end
     end
 
+    def read_expression(prompt = "Expression: ")
+      f = ->(s) {
+        IRB::InputCompletor.retrieve_completion_data(s, bind: TOPLEVEL_BINDING).compact
+      }
+      read_from_minibuffer(prompt, completion_proc: f)
+    end
+
+    def read_object(prompt = "Object: ")
+      s = read_expression(prompt)
+      eval(s)
+    end
+
     HOOKS = Hash.new { |h, k| h[k] = [] }
 
     def add_hook(name, func = nil, &block)

data/lib/textbringer/version.rb

@@ -1,3 +1,3 @@
 module Textbringer
-  VERSION = "1.1.2"
+  VERSION = "1.3.0"
 end

data/lib/textbringer.rb

@@ -38,3 +38,4 @@ require_relative "textbringer/input_methods/t_code_input_method"
 require_relative "textbringer/input_methods/hiragana_input_method"
 require_relative "textbringer/plugin"
 require_relative "textbringer/controller"
+require_relative "textbringer/default_output"

data/textbringer.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.add_runtime_dependency "curses", ">= 1.2.7"
   spec.add_runtime_dependency "unicode-display_width", ">= 1.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textbringer
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Shugo Maeda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -171,7 +171,7 @@ email:
 executables:
 - tbclient
 - tbtags
-- textbringer
+- txtb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -184,13 +184,14 @@ files:
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
+- README.ja.md
 - README.md
 - Rakefile
 - bin/console
 - bin/merge_mazegaki_dic
 - exe/tbclient
 - exe/tbtags
-- exe/textbringer
+- exe/txtb
 - lib/textbringer.rb
 - lib/textbringer/buffer.rb
 - lib/textbringer/color.rb
@@ -212,6 +213,7 @@ files:
 - lib/textbringer/commands/windows.rb
 - lib/textbringer/config.rb
 - lib/textbringer/controller.rb
+- lib/textbringer/default_output.rb
 - lib/textbringer/errors.rb
 - lib/textbringer/face.rb
 - lib/textbringer/faces/basic.rb
@@ -251,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="