textbringer-recentf 1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b12d05d8ed3520a2514ce6931439343ca9f900b6a0f75efa7c1ff5e28aa0dae
+  data.tar.gz: 1d358ff5003e6693601e58be895eb2e2bf3f28e6b2146751aee0bd731331c599
+SHA512:
+  metadata.gz: 899e72623c4ed4ba72528b1f8fd192561a72a6844ff24481f399baa5d4bc5bff51efd0b2ee1ab67f30da1e39206a848d21d59d9c956cbdafc6f5d8ea2b6f6cdf
+  data.tar.gz: 7574cad9c78232faf010753dc990feb42482982084a561691b94edc5ab5d7d149d5cc2c9dbc4b3dfb9b5a6b6aa3f369d7f62f158e385e325df4890cc54879f9b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "textbringer-minibuffer-extension"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Akihiro Kurotani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# textbringer-recentf
+
+Emacs-like recent file history plugin for [Textbringer](https://github.com/shugo/textbringer).
+
+## Dependencies
+
+- [textbringer](https://github.com/shugo/textbringer) >= 1.4
+- [textbringer-minibuffer-extension](https://github.com/kurod1492/textbringer-minibuffer-extension) >= 0.1.0
+
+## Installation
+
+### Via git clone
+
+Clone this repository and its dependency to your Textbringer plugins directory:
+
+```bash
+# Install dependency
+git clone https://github.com/kurod1492/textbringer-minibuffer-extension.git ~/.textbringer/plugins/textbringer-minibuffer-extension
+
+# Install this plugin
+git clone https://github.com/kurod1492/textbringer-recentf.git ~/.textbringer/plugins/textbringer-recentf
+```
+
+### Via rake install
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+Note: You also need to install the dependency [textbringer-minibuffer-extension](https://github.com/kurod1492/textbringer-minibuffer-extension).
+
+## Configuration
+
+Add the following to your `~/.textbringer.rb`:
+
+```ruby
+# Key binding (optional)
+GLOBAL_MAP.define_key("\C-x\C-r", :recentf)
+
+# Maximum number of files to remember (default: 100)
+CONFIG[:recentf_max_items] = 100
+
+# History file path (default: ~/.textbringer/recentf)
+CONFIG[:recentf_file] = "~/.textbringer/recentf"
+
+# Patterns to exclude from history
+CONFIG[:recentf_exclude_patterns] = [
+  %r{^/tmp/},
+  %r{COMMIT_EDITMSG$}
+]
+```
+
+## Usage
+
+| Command | Description |
+|---------|-------------|
+| `M-x recentf` | Open a file from recent history |
+| `M-x recentf_cleanup` | Remove non-existent files from history |
+
+## License
+
+MIT

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", "test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/textbringer/recentf/version.rb

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

data/lib/textbringer/recentf.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "recentf/version"
+
+module Textbringer
+  CONFIG[:recentf_max_items] = 100
+  CONFIG[:recentf_file] = File.expand_path("~/.textbringer/recentf")
+  CONFIG[:recentf_exclude_patterns] = [
+    %r{^/tmp/},
+    %r{COMMIT_EDITMSG$}
+  ]
+
+  module Recentf
+    @last_added = nil
+
+    class << self
+      attr_accessor :last_added
+
+      def file_path
+        File.expand_path(CONFIG[:recentf_file])
+      end
+
+      def max_items
+        CONFIG[:recentf_max_items]
+      end
+
+      def exclude_patterns
+        CONFIG[:recentf_exclude_patterns]
+      end
+
+      def load
+        return [] unless File.exist?(file_path)
+        File.readlines(file_path, chomp: true)
+      end
+
+      def save(list)
+        dir = File.dirname(file_path)
+        FileUtils.mkdir_p(dir) unless File.directory?(dir)
+        File.write(file_path, list.take(max_items).join("\n") + "\n")
+      end
+
+      def add(path)
+        return if path.nil? || path.empty?
+        path = File.expand_path(path)
+        return if exclude_patterns.any? { |pat| pat.match?(path) }
+        return if path == last_added
+
+        list = load
+        list.delete(path)
+        list.unshift(path)
+        save(list)
+        self.last_added = path
+      end
+
+      def cleanup
+        list = load.select { |f| File.exist?(f) }
+        save(list)
+        list.size
+      end
+    end
+  end
+
+  define_command(:recentf, doc: "Open a file from recent file history.") do
+    list = Recentf.load
+    if list.empty?
+      raise EditorError, "No recent files"
+    end
+
+    completion_proc = ->(s) {
+      list.select { |f| f.include?(s) }
+    }
+    file = read_from_minibuffer("Recent file: ",
+                                completion_proc: completion_proc,
+                                history: list)
+    MinibufferHistory.add(:file, file) if defined?(MinibufferHistory)
+    find_file(file)
+  end
+
+  define_command(:recentf_cleanup,
+                 doc: "Remove non-existent files from recent file history.") do
+    count = Recentf.cleanup
+    message("Cleaned up. #{count} files remaining.")
+  end
+
+  # Track buffer switches to files
+  # Cannot use this_command check because recursive_edit in minibuffer
+  # clears this_command before post_command_hook runs
+  add_hook(:post_command_hook) do
+    file = Buffer.current&.file_name
+    if file && !file.empty?
+      Recentf.add(file)
+    end
+  end
+
+  # Record files specified on command line (txtb filename)
+  # foreground runs after command_loop starts, when files are already opened
+  foreground do
+    ARGV.each do |arg|
+      path = File.expand_path(arg)
+      Recentf.add(path) if File.exist?(path)
+    end
+  end
+end

data/lib/textbringer_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "textbringer/recentf"

data/textbringer-recentf.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "textbringer/recentf/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "textbringer-recentf"
+  spec.version       = Textbringer::Recentf::VERSION
+  spec.authors       = ["Akihiro Kurotani"]
+  spec.email         = ["kurod1492@gmail.com"]
+
+  spec.summary       = "Recent file history plugin for Textbringer."
+  spec.description   = "Provides Emacs-like recent file history functionality for Textbringer."
+  spec.homepage      = "https://github.com/kurod1492/textbringer-recentf"
+  spec.license       = "MIT"
+  spec.metadata      = { "rubygems_mfa_required" => "true" }
+
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "textbringer", ">= 1.4"
+  spec.add_runtime_dependency "textbringer-minibuffer-extension", ">= 1"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.0"
+  spec.add_development_dependency "test-unit"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: textbringer-recentf
+version: !ruby/object:Gem::Version
+  version: '1'
+platform: ruby
+authors:
+- Akihiro Kurotani
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: textbringer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: textbringer-minibuffer-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides Emacs-like recent file history functionality for Textbringer.
+email:
+- kurod1492@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/textbringer/recentf.rb
+- lib/textbringer/recentf/version.rb
+- lib/textbringer_plugin.rb
+- textbringer-recentf.gemspec
+homepage: https://github.com/kurod1492/textbringer-recentf
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.7
+specification_version: 4
+summary: Recent file history plugin for Textbringer.
+test_files: []