textbringer-auto-revert 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b9c293b790a5a977dad299b00b2fefe137f781e2afe8b139170f9b370d931dd
-  data.tar.gz: d430d791ddc748a74ba7c5d9bca93fbf99a5433c7f34400dbb9ee0ea50e53ced
+  metadata.gz: 510415dcb98e0c25dd5c0c53c05fc63700cb0657e1ebf61290de748e7bb33751
+  data.tar.gz: 7ee315ca74e6c87b029c5d04f23b1ae7f878c632469838b68687e7420d058bc6
 SHA512:
-  metadata.gz: eb4563e64fd3d7a3082968d0263a7f4bb79d2b662f77cde07a25454754bdf71cdbf1d8fb85a551664800a1ce656b249954dd178a6d1dd2ed869f9b96a49938a0
-  data.tar.gz: f5d6bb33ebf2309d917913ba4cedce9c55c55db1859f93af1cd871e9e5512438183aa9db5caffbc3320df0c833d4445e294158c1f67b15696d033e94f3cc6dc7
+  metadata.gz: 9ad2cc40e79a3f93e1e07b5dea10d4825b1cd04ab829d2f1eaf8bcf9cb054dc1385ee6a32fafbb7c3e7ceaa65ae1f3997308f434c654bc1142a02ef546311e18
+  data.tar.gz: b4dbc334617ec284146c7d810af63f3be130b20eeeb2e18f7f3e98b6090ad3fbe10b69592c28113950130ab32cb72ee8605c7033bc9f5351a936654462ea37f5

data/README.md

@@ -18,20 +18,26 @@ bundle add textbringer-auto-revert
 
 ## Usage
 
+**Auto-revert mode is enabled by default** when the plugin is loaded.
+
+When a file is modified externally and the buffer has no unsaved changes, the buffer will automatically revert to the file's contents after any command execution.
+
 ### 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 |
+| `global_auto_revert_mode` | Toggle global auto-revert mode on/off |
+
+### Disabling
 
-### Example
+To temporarily disable, run `M-x global_auto_revert_mode`.
 
-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
+To permanently disable, uninstall the gem or add to your Textbringer config:
+
+```ruby
+Textbringer::GlobalAutoRevertMode.disable
+Textbringer::GlobalAutoRevertMode.enabled = false
+```
 
 ### Configuration
 

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

@@ -2,6 +2,6 @@
 
 module Textbringer
   module AutoRevert
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/textbringer/auto-revert.rb

@@ -5,77 +5,32 @@ require_relative "auto-revert/version"
 module Textbringer
   CONFIG[:auto_revert_verbose] = true
 
-  module AutoRevert
-    @global_mode = false
-
-    class << self
-      attr_accessor :global_mode
-    end
-
+  class GlobalAutoRevertMode < GlobalMinorMode
     POST_COMMAND_HOOK = -> {
-      return unless AutoRevert.should_check?
-
       buffer = Buffer.current
-      return unless AutoRevert.buffer_eligible?(buffer)
+      return unless buffer.file_name && !buffer.name.start_with?("*")
       return unless buffer.file_modified?
 
-      # バッファが未変更なら自動revert
       if !buffer.modified?
         buffer.revert
-        Textbringer.message("Reverted buffer from file") if CONFIG[:auto_revert_verbose]
+        message("Reverted buffer from file") if CONFIG[:auto_revert_verbose]
       else
-        Textbringer.message("Buffer has unsaved changes; file changed on disk")
+        message("Buffer has unsaved changes; file changed on disk")
       end
     }
 
-    def self.should_check?
-      @global_mode || Buffer.current[:auto_revert_mode]
+    def self.enable
+      add_hook(:post_command_hook, POST_COMMAND_HOOK)
+      message("Global auto-revert mode enabled")
     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")
+    def self.disable
+      remove_hook(:post_command_hook, POST_COMMAND_HOOK)
+      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
+  # Enable by default on plugin load
+  GlobalAutoRevertMode.enable
+  GlobalAutoRevertMode.enabled = true
 end

data/test/test_helper.rb

@@ -81,6 +81,25 @@ module Textbringer
       module_function(name)
     end
   end
+
+  class GlobalMinorMode
+    class << self
+      attr_accessor :enabled
+      alias enabled? enabled
+    end
+
+    def self.add_hook(name, hook)
+      Textbringer.add_hook(name, hook)
+    end
+
+    def self.remove_hook(name, hook)
+      Textbringer.remove_hook(name, hook)
+    end
+
+    def self.message(msg)
+      Textbringer.message(msg)
+    end
+  end
 end
 
 require "textbringer/auto-revert"

data/test/textbringer_auto_revert_test.rb

@@ -2,7 +2,7 @@
 
 require "test_helper"
 
-class Textbringer::AutoRevertTest < Test::Unit::TestCase
+class Textbringer::GlobalAutoRevertModeTest < Test::Unit::TestCase
   include Textbringer
 
   def setup
@@ -11,7 +11,6 @@ class Textbringer::AutoRevertTest < Test::Unit::TestCase
     Textbringer::Buffer.list = [@buffer]
     Textbringer.messages = []
     Textbringer::HOOKS.clear
-    Textbringer::AutoRevert.global_mode = false
   end
 
   test "VERSION is defined" do
@@ -20,77 +19,51 @@ class Textbringer::AutoRevertTest < Test::Unit::TestCase
     end
   end
 
-  test "global_auto_revert_mode enables global mode" do
-    assert_equal false, Textbringer::AutoRevert.global_mode
+  test "enable adds hook and shows message" do
+    Textbringer::GlobalAutoRevertMode.enable
 
-    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
+                    Textbringer::GlobalAutoRevertMode::POST_COMMAND_HOOK
+    assert_includes Textbringer.messages, "Global auto-revert mode enabled"
   end
 
-  test "auto_revert_mode toggles off" do
-    Textbringer::Commands.auto_revert_mode  # enable
-    Textbringer::Commands.auto_revert_mode  # disable
+  test "disable removes hook and shows message" do
+    Textbringer::GlobalAutoRevertMode.enable
+    Textbringer::GlobalAutoRevertMode.disable
 
-    assert_equal false, @buffer[:auto_revert_mode]
+    refute_includes Textbringer::HOOKS[:post_command_hook],
+                    Textbringer::GlobalAutoRevertMode::POST_COMMAND_HOOK
+    assert_includes Textbringer.messages, "Global auto-revert mode disabled"
   end
 
   test "reverts buffer when file is modified and buffer is not modified" do
-    Textbringer::Commands.global_auto_revert_mode
+    Textbringer::GlobalAutoRevertMode.enable
     @buffer.file_modified = true
     @buffer.modified = false
 
-    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+    Textbringer::GlobalAutoRevertMode::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
+    Textbringer::GlobalAutoRevertMode.enable
     @buffer.file_modified = true
     @buffer.modified = true
 
-    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+    Textbringer::GlobalAutoRevertMode::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
+    Textbringer::GlobalAutoRevertMode.enable
     @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
+    Textbringer::GlobalAutoRevertMode::POST_COMMAND_HOOK.call
 
     assert_equal false, @buffer.reverted
   end
@@ -98,9 +71,9 @@ class Textbringer::AutoRevertTest < Test::Unit::TestCase
   test "skips special buffers starting with *" do
     @buffer.name = "*scratch*"
     @buffer.file_modified = true
-    Textbringer::Commands.global_auto_revert_mode
+    Textbringer::GlobalAutoRevertMode.enable
 
-    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+    Textbringer::GlobalAutoRevertMode::POST_COMMAND_HOOK.call
 
     assert_equal false, @buffer.reverted
   end
@@ -108,9 +81,9 @@ class Textbringer::AutoRevertTest < Test::Unit::TestCase
   test "skips buffers without file_name" do
     @buffer.file_name = nil
     @buffer.file_modified = true
-    Textbringer::Commands.global_auto_revert_mode
+    Textbringer::GlobalAutoRevertMode.enable
 
-    Textbringer::AutoRevert::POST_COMMAND_HOOK.call
+    Textbringer::GlobalAutoRevertMode::POST_COMMAND_HOOK.call
 
     assert_equal false, @buffer.reverted
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textbringer-auto-revert
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yancya