textbringer-auto-revert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b9c293b790a5a977dad299b00b2fefe137f781e2afe8b139170f9b370d931dd
+  data.tar.gz: d430d791ddc748a74ba7c5d9bca93fbf99a5433c7f34400dbb9ee0ea50e53ced
+SHA512:
+  metadata.gz: eb4563e64fd3d7a3082968d0263a7f4bb79d2b662f77cde07a25454754bdf71cdbf1d8fb85a551664800a1ce656b249954dd178a6d1dd2ed869f9b96a49938a0
+  data.tar.gz: f5d6bb33ebf2309d917913ba4cedce9c55c55db1859f93af1cd871e9e5512438183aa9db5caffbc3320df0c833d4445e294158c1f67b15696d033e94f3cc6dc7

data/LICENSE.txt

@@ -0,0 +1,13 @@
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+Version 2, December 2004
+
+Copyright (C) 2026 Shinta Koyanagi <yancya@upec.jp>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,54 @@
+# Textbringer Auto Revert
+
+A Textbringer plugin that automatically reverts buffers when files are modified externally.
+
+## Installation
+
+Install the gem by executing:
+
+```bash
+gem install textbringer-auto-revert
+```
+
+Or add it to your Gemfile:
+
+```bash
+bundle add textbringer-auto-revert
+```
+
+## Usage
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `auto_revert_mode` | Toggle auto-revert mode for the current buffer |
+| `global_auto_revert_mode` | Toggle global auto-revert mode for all buffers |
+
+### Example
+
+1. Open a file in Textbringer (`C-x C-f`)
+2. Enable global auto-revert mode: `M-x global_auto_revert_mode`
+3. Edit the file externally (e.g., in another terminal)
+4. Execute any command in Textbringer (e.g., `C-n`)
+5. The buffer will automatically revert to the file's contents
+
+### Configuration
+
+| Key | Default | Description |
+|-----|---------|-------------|
+| `:auto_revert_verbose` | `true` | Show message when buffer is reverted |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yancya/textbringer-auto-revert.
+
+## License
+
+The gem is available as open source under the terms of the [WTFPL](http://www.wtfpl.net/).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/textbringer/auto-revert/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Textbringer
+  module AutoRevert
+    VERSION = "0.1.0"
+  end
+end

data/lib/textbringer/auto-revert.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "auto-revert/version"
+
+module Textbringer
+  CONFIG[:auto_revert_verbose] = true
+
+  module AutoRevert
+    @global_mode = false
+
+    class << self
+      attr_accessor :global_mode
+    end
+
+    POST_COMMAND_HOOK = -> {
+      return unless AutoRevert.should_check?
+
+      buffer = Buffer.current
+      return unless AutoRevert.buffer_eligible?(buffer)
+      return unless buffer.file_modified?
+
+      # バッファが未変更なら自動revert
+      if !buffer.modified?
+        buffer.revert
+        Textbringer.message("Reverted buffer from file") if CONFIG[:auto_revert_verbose]
+      else
+        Textbringer.message("Buffer has unsaved changes; file changed on disk")
+      end
+    }
+
+    def self.should_check?
+      @global_mode || Buffer.current[:auto_revert_mode]
+    end
+
+    def self.buffer_eligible?(buffer)
+      buffer.file_name && !buffer.name.start_with?("*")
+    end
+
+    def self.enable_global
+      @global_mode = true
+      Textbringer.add_hook(:post_command_hook, POST_COMMAND_HOOK)
+      Textbringer.message("Global auto-revert mode enabled")
+    end
+
+    def self.disable_global
+      @global_mode = false
+      # ローカルモードが有効なバッファがなければフック削除
+      unless Buffer.list.any? { |b| b[:auto_revert_mode] }
+        Textbringer.remove_hook(:post_command_hook, POST_COMMAND_HOOK)
+      end
+      Textbringer.message("Global auto-revert mode disabled")
+    end
+  end
+
+  module Commands
+    define_command(:auto_revert_mode,
+      doc: "Toggle auto-revert mode for the current buffer.") do
+      buffer = Buffer.current
+      if buffer[:auto_revert_mode]
+        buffer[:auto_revert_mode] = false
+        Textbringer.message("Auto-revert mode disabled in this buffer")
+      else
+        buffer[:auto_revert_mode] = true
+        # フックがなければ追加
+        unless HOOKS[:post_command_hook].include?(AutoRevert::POST_COMMAND_HOOK)
+          Textbringer.add_hook(:post_command_hook, AutoRevert::POST_COMMAND_HOOK)
+        end
+        Textbringer.message("Auto-revert mode enabled in this buffer")
+      end
+    end
+
+    define_command(:global_auto_revert_mode,
+      doc: "Toggle global auto-revert mode for all buffers.") do
+      if AutoRevert.global_mode
+        AutoRevert.disable_global
+      else
+        AutoRevert.enable_global
+      end
+    end
+  end
+end

data/lib/textbringer_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "textbringer/auto-revert"

data/test/test_helper.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+# Mock Textbringer for testing without the actual dependency
+module Textbringer
+  CONFIG = {} unless defined?(CONFIG)
+  HOOKS = Hash.new { |h, k| h[k] = [] } unless defined?(HOOKS)
+
+  class << self
+    attr_accessor :messages
+  end
+  self.messages = []
+
+  class Buffer
+    @current = nil
+    @list = []
+
+    class << self
+      attr_accessor :current, :list
+    end
+
+    attr_accessor :file_name, :name
+    attr_reader :reverted, :properties
+
+    def initialize(name: nil, file_name: nil)
+      @name = name || "test"
+      @file_name = file_name
+      @modified = false
+      @file_modified = false
+      @reverted = false
+      @properties = {}
+    end
+
+    def [](key)
+      @properties[key]
+    end
+
+    def []=(key, value)
+      @properties[key] = value
+    end
+
+    def modified?
+      @modified
+    end
+
+    def modified=(val)
+      @modified = val
+    end
+
+    def file_modified?
+      @file_modified
+    end
+
+    def file_modified=(val)
+      @file_modified = val
+    end
+
+    def revert
+      @reverted = true
+    end
+  end
+
+  module_function
+
+  def add_hook(name, hook)
+    HOOKS[name] << hook unless HOOKS[name].include?(hook)
+  end
+
+  def remove_hook(name, hook)
+    HOOKS[name].delete(hook)
+  end
+
+  def message(msg)
+    Textbringer.messages << msg
+  end
+
+  module Commands
+    def self.define_command(name, doc: nil, &block)
+      define_method(name, &block)
+      module_function(name)
+    end
+  end
+end
+
+require "textbringer/auto-revert"
+
+require "test/unit"

data/test/textbringer_auto_revert_test.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Textbringer::AutoRevertTest < Test::Unit::TestCase
+  include Textbringer
+
+  def setup
+    @buffer = Textbringer::Buffer.new(name: "test.txt", file_name: "/tmp/test.txt")
+    Textbringer::Buffer.current = @buffer
+    Textbringer::Buffer.list = [@buffer]
+    Textbringer.messages = []
+    Textbringer::HOOKS.clear
+    Textbringer::AutoRevert.global_mode = false
+  end
+
+  test "VERSION is defined" do
+    assert do
+      ::Textbringer::AutoRevert.const_defined?(:VERSION)
+    end
+  end
+
+  test "global_auto_revert_mode enables global mode" do
+    assert_equal false, Textbringer::AutoRevert.global_mode
+
+    Textbringer::Commands.global_auto_revert_mode
+
+    assert_equal true, Textbringer::AutoRevert.global_mode
+    assert_includes Textbringer::HOOKS[:post_command_hook],
+                    Textbringer::AutoRevert::POST_COMMAND_HOOK
+  end
+
+  test "global_auto_revert_mode toggles off" do
+    Textbringer::Commands.global_auto_revert_mode  # enable
+    Textbringer::Commands.global_auto_revert_mode  # disable
+
+    assert_equal false, Textbringer::AutoRevert.global_mode
+  end
+
+  test "auto_revert_mode enables local mode for current buffer" do
+    assert_nil @buffer[:auto_revert_mode]
+
+    Textbringer::Commands.auto_revert_mode
+
+    assert_equal true, @buffer[:auto_revert_mode]
+    assert_includes Textbringer::HOOKS[:post_command_hook],
+                    Textbringer::AutoRevert::POST_COMMAND_HOOK
+  end
+
+  test "auto_revert_mode toggles off" do
+    Textbringer::Commands.auto_revert_mode  # enable
+    Textbringer::Commands.auto_revert_mode  # disable
+
+    assert_equal false, @buffer[:auto_revert_mode]
+  end
+
+  test "reverts buffer when file is modified and buffer is not modified" do
+    Textbringer::Commands.global_auto_revert_mode
+    @buffer.file_modified = true
+    @buffer.modified = false
+
+    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+
+    assert_equal true, @buffer.reverted
+    assert_includes Textbringer.messages, "Reverted buffer from file"
+  end
+
+  test "does not revert buffer when buffer has unsaved changes" do
+    Textbringer::Commands.global_auto_revert_mode
+    @buffer.file_modified = true
+    @buffer.modified = true
+
+    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+
+    assert_equal false, @buffer.reverted
+    assert_includes Textbringer.messages, "Buffer has unsaved changes; file changed on disk"
+  end
+
+  test "does not revert when file is not modified" do
+    Textbringer::Commands.global_auto_revert_mode
+    @buffer.file_modified = false
+    @buffer.modified = false
+
+    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+
+    assert_equal false, @buffer.reverted
+  end
+
+  test "does not check when neither global nor local mode is enabled" do
+    @buffer.file_modified = true
+    @buffer.modified = false
+
+    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+
+    assert_equal false, @buffer.reverted
+  end
+
+  test "skips special buffers starting with *" do
+    @buffer.name = "*scratch*"
+    @buffer.file_modified = true
+    Textbringer::Commands.global_auto_revert_mode
+
+    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+
+    assert_equal false, @buffer.reverted
+  end
+
+  test "skips buffers without file_name" do
+    @buffer.file_name = nil
+    @buffer.file_modified = true
+    Textbringer::Commands.global_auto_revert_mode
+
+    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+
+    assert_equal false, @buffer.reverted
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: textbringer-auto-revert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yancya
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: textbringer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Textbringer plugin that automatically reverts buffers when files are
+  modified externally.
+email:
+- yancya@upec.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/textbringer/auto-revert.rb
+- lib/textbringer/auto-revert/version.rb
+- lib/textbringer_plugin.rb
+- test/test_helper.rb
+- test/textbringer_auto_revert_test.rb
+homepage: https://github.com/yancya/textbringer-auto-revert
+licenses:
+- WTFPL
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/yancya/textbringer-auto-revert
+  source_code_uri: https://github.com/yancya/textbringer-auto-revert
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: AutoRevert mode for Textbringer
+test_files: []