file-tail 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82cf3f0b3b8d131b06101e28680a2dd0d2fb70fc
-  data.tar.gz: 59c4c79c2499a858925cbd96f87052a875616118
+SHA256:
+  metadata.gz: 8fcbea1582da9d2d6ce23fc0826608abf44625e90577916288001461593c2e0a
+  data.tar.gz: '0780cfca7c7d53f9a005ac2e1035daa249a758eab32a3b29aefb4142bd624127'
 SHA512:
-  metadata.gz: 4b5cd1010abe3d92b58d2a43f08fc1f587b834e2130e836371a11b6989cb6fa605e5770e8a662b649643c8346f44919a96ca7c04b92b91e69358a0aadbdf02b0
-  data.tar.gz: 23982bf55e95a0369e30d7cce2fd77f4d2736006091a59daa9781eb1e7d4163c7b9db9b46d0c1019ebec9be222f2aa9de0497faa1a0fdbfa28093ae8a6fa3509
+  metadata.gz: adeee1b62fe358f4e8f3ae1f13127b6b94e741e9520f94611bff8e4f1083f5ccbb5a0fbb3e8d9a6e68281e12231304b8cb24de644b7c062c3db76e9062ca4589
+  data.tar.gz: a9057bdfb9b771c1ee58cda13ea0f7639b2ff1b599b5628f5815060f52063d1ee354cd2dfd2368b96add7da4a0cdad3447c6622ed45bcc95a7f8926c8168fd46

data/.all_images.yml

@@ -0,0 +1,19 @@
+dockerfile: |-
+  RUN apk add --no-cache build-base yaml-dev git openssl-dev
+
+fail_fast: true
+
+script: &script |-
+  echo -e "\e[1m"
+  ruby -v
+  echo -e "\e[0m"
+  bundle update --all
+  bundle install --jobs=$(getconf _NPROCESSORS_ONLN)
+  rake test
+
+images:
+  ruby:4.0-alpine: *script
+  ruby:3.4-alpine: *script
+  ruby:3.3-alpine: *script
+  ruby:3.2-alpine: *script
+  ruby:3.1-alpine: *script

data/.github/workflows/static.yml

@@ -0,0 +1,51 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [ "master" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+      - name: Generate Documentation
+        run: |
+          gem install gem_hadar
+          bundle install
+          rake doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

data/.gitignore

@@ -3,6 +3,10 @@
 .AppleDouble
 .bundle
 .rbx
+.utilsrc
+.yardoc
 Gemfile.lock
 coverage
+errors.lst
 pkg
+tmp

data/.travis.yml

@@ -1,8 +1,10 @@
 rvm:
   - 2.1
   - 2.2
-  - 2.3.3
-  - 2.4.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
   - ruby-head
   - jruby-head
 sudo: false

data/CHANGES.md

@@ -0,0 +1,190 @@
+# Changes
+
+## 2026-01-02 v1.4.0
+
+- Enhanced file reopening logic to handle `Errno::ENOENT` and `Errno::ESTALE`
+  errors separately, preventing line skipping during file rotation
+- Fixed buffer size parameter passing and cleaned up the close block
+- Added nil safety check for `@out.path` before removing temporary files
+- Updated gemspec to include the `LICENSE` file and added a GitHub Actions
+  workflow
+- Replaced the old documentation in README with a comprehensive architecture
+  overview, usage examples, and debugging sections
+- Added automated documentation deployment workflow using GitHub Actions with
+  Ruby **3.4** environment
+- Removed unnecessary `t =` assignment for thread in `rtail` binary
+- Removed support for Ruby **3.0** Alpine image in CI configuration
+- Renamed `COPYING` file to `LICENSE` for better standard compliance
+- Added `.yardoc` to gitignore and rake ignore list
+- Updated test file path to use the `tmp` directory for better test
+  organization
+- Added `tmp` directory to gitignore, gemspec, and git tracking with
+  `tmp/.gitkeep`
+- Updated CI image configuration to support Ruby **4.0** with `yaml-dev` and
+  `openssl-dev` dependencies
+- Updated gem metadata and dependencies, including `rubygems_version` to
+  **4.0.2** and `gem_hadar` development dependency to **>= 2.16.3**
+- Added changelog generation support to the Rakefile for automated changelog
+  management
+- Updated Dockerfile dependencies for Ruby version detection and added Ruby
+  **3.4**-alpine image support
+- Fixed typos in the codebase
+
+## 2024-09-13 v1.3.0
+
+### Significant Changes
+
+* **Improved waiting for log output by counting lines**
+  + Increased timeout from 2 seconds to 10 seconds in multiple places
+* **Added Ruby version check in Dockerfile**
+  + Update `gem update --system` and installation to be conditional on Ruby version
+  + Replace `bundle` with `bundle install` in script section
+* **Convert CHANGES file to CHANGES\.md**
+
+### Bug Fixes
+
+* **Add exit handler to delete temporary file**
+  - Added at_exit block to delete test file created in setup method.
+* **Refactor File class for debugging**
+  - Remove hardcoded `$DEBUG` variable usage in reopen_file and output_debug_information methods
+  - Introduce debug? method to check if `FILE_TAIL_DEBUG` environment variable is set to 1.
+
+### Dependency Updates
+
+* **Update Ruby dependencies and add new development dependencies**
+  + Added `.all_images.yml` file with Dockerfile configuration
+  + Updated Gemfile to use Ruby **3.5.18** instead of **2.7.8**
+  + Updated Rakefile to ignore additional files
+  + Updated `file-tail.gemspec` to include `.all_images.yml` in the list of files
+  + Updated `tests/file_tail_test.rb` to use absolute path for test file
+  + Added new development dependencies: `all_images`, `simplecov`, and `debug`
+    + Updated dependency versions: `gem_hadar` to **1.17.1**, `test-unit` to
+      **3.0**, and `tins` to **1.0**
+
+## 2016-04-19 v1.2.0
+
+* Make line separator configurable
+
+## 2016-04-19 v1.1.1
+
+* Fix tests on Ruby 2.3.0
+
+## 2014-09-26 v1.1.0
+
+* Depend on tins ~ 1.0
+
+## 2012-05-31 v1.0.10
+
+* Use rewind to force IO#lineno to be reset.
+
+## 2012-05-31 v1.0.9
+
+* Reopen file in :top mode at the beginning.
+
+## 2011-12-24 v1.0.8
+
+* Support simplecov.
+
+## 2011-07-15 v1.0.7
+
+* Use gem_hadar to shorten Rakefile.
+
+## 2011-06-25 v1.0.6
+
+* Create a gem spec file again.
+* Added a File::Tail::Group to tail multiple files more easily.
+
+## 2010-03-25 v1.0.5
+
+* Added rtail executable, a nice app to supervise logfiles and logdirs.
+* Disabled creation of gem spec file.
+* Cleaned up documentation a bit.
+
+## 2009-08-21 v1.0.4
+
+* Fixed the threaded tests for Ruby 1.9.
+* Create a gem spec file.
+* Some cleanup.
+
+## 2008-04-07 v1.0.3
+
+* Danny Colligan <danny.colligan@sendori.com> reported a memory leak in long
+  running scripts using file-tail. I changed file-ta il to only use block.call,
+  which seems to improve the memory behaviour. I am still not sure, where the
+  problem actually stems f rom, though.
+
+## 2007-04-19 v1.0.2
+
+* make_doc.rb was missing from the source archive. Thanks to Rick Ohnemus
+  <rick.ohnemus@systemware.com> for reporting it.
+
+## 2007-04-19 v1.0.1
+
+* Bugfix: File::Tail::Logfile#open with block, now closes the file like
+  File#open does. Found by Alex Doan <alex.doan@wachovia. com>,
+  ruby-talk:248383.
+
+## 2007-03-30 v1.0.0
+
+* Bugfix: David.Barzilay@swisscom.com reported, that file tails may skip some
+  log file lines, after rotating it. I think, that I fixed that problem.
+* Added a after_reopen callback as well, that is called after reopening of the
+  tailed file has occured.
+* Removed rewind/wind methods even earlier than planned: I placed the
+  deprecation warning for rewind method in File instead of File::Tail, which
+  caused rewind to stop working completely after loading file/tail. Duh! I
+  blame vim's matchit, because it jump ed to the wrong end keyword.
+
+## 2007-02-08 v0.1.4
+
+* Renamed rewind method to backward, and wind method to forward, because
+  someone already had the good idea to name a method IO# rewind, which was
+  overwritten by the mixed in File::Tail methods. The old methods are now
+  deprecated and will be removed in a n ew 0.2.x version of the library.
+* Added a bit more of documentation.
+
+## 2005-08-20 v0.1.3
+
+* Applied LOAD_PATH patch by Daniel Berger, binary mode changes were already in
+  the CVS. Seemed to be like cheating to me, thou gh. ;)
+* Skipping one windows test for the moment, too. Sigh!
+
+## 2004-09-30 v0.1.2
+
+* First Rubyforge release
+* Added Rakefile
+* Supports gem build now.
+
+## 2004-09-01 v0.1.1
+
+* Josh Endries <josh@endries.org> found a bug that caused File::Tail to
+  malfunction on FreeBSD. Hotfix: Use a side effect of se ek to clearerr the
+  tailed file handle after EOFError has been raised.
+
+## 2004-04-13 v0.1.0
+
+* API documentation with rdoc.
+* return_if_eof attribute added.
+* Added array return mode for finite tail call without block given.
+* install.rb now uses ruby version site_dir.
+* Some code and directory structure cleanup.
+
+## 2002-08-02 v0.0.2
+
+* Heavy refactoring, more and smaller methods and expception handling
+* Added check for inode and device equality of files as suggested by James
+  F.Hranicky <jfh@cise.ufl.edu> and Curt Sampson <cjs@ cynic.net> to cover
+  remove rotation
+* If filesize shrinks suddenly, File::Tail assumes that copy and truncate
+  rotation has happend: The file is reopened and every new line is handled.
+* NFS-Fix: Errno::ESTALE is caught.
+* wind added to skip the first n lines, as James F.Hranicky's suggested and
+  changed name of last-method to rewind, because I li ked his method names
+  better than mine ;)
+* Renamed next to tail either.
+* The API has changed - but I think very few people care at the moment.
+* Lots of tests added.
+
+## 2002-07-30 v0.0.1
+
+* Initial Release

data/Gemfile

@@ -3,8 +3,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-group :development do
-  gem 'simplecov'
-  gem 'utils'
-end

data/README.md

@@ -5,69 +5,308 @@
 This is a small ruby library that allows it to "tail" files in Ruby, including
 following a file, that still is growing like the unix command 'tail -f' can.
 
-## Download
+## Documentation
 
-The latest version of *File::Tail* (file-tail) can be found at
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/file-tail/)
+
+## Architecture Overview
+
+File::Tail follows a well-defined architectural pattern with clear
+separation of concerns between several key components:
 
+### Core Components
 
-http://flori.github.com/file-tail
+**File::Tail Module**
+- The central hub extending File objects with tailing capabilities 🔄
+- Provides core methods for forward/backward traversal and tailing 📊
+- Handles file system events like rotation, truncation, and deletion 🔁
+
+**File::Tail::Logfile**
+- A convenience class that simplifies opening and tailing files with options 🚀
+- Includes File::Tail module for direct file access 🧠
+- Supports various initialization patterns for flexible usage 🔄
+
+**File::Tail::Group**
+- Manages multiple files to be tailed together 🔄
+- Uses ThreadGroup to coordinate multiple tailing threads ⏳
+- Provides batch operations for concurrent file monitoring 📊
+
+**File::Tail::Tailer**
+- A Thread subclass that supervises a single file's tailing 🧠
+- Uses queues for line buffering and thread-safe communication 📦
+- Implements method_missing for thread-local variable access ⚡
+
+### Component Interactions
+
+```mermaid
+graph LR
+    A[File::Tail] --> B[File::Tail::Logfile]
+    A --> C[File::Tail::Group]
+    C --> D[File::Tail::Tailer]
+    D --> E[Thread]
+    A --> F[File::Tail::LineExtension]
+    F --> G[Lines from tailers]
+```
+
+The File::Tail module acts as the foundation, providing core functionality that
+is extended by Logfile and Group classes. The Group class coordinates multiple
+Tailer threads, each managing a single file's tailing process.
+
+### Loading Mechanism
+
+File::Tail supports two primary access patterns:
+
+1. **Direct File Extension** - Extending File objects directly with File::Tail:
+   ```ruby
+   File.open(filename) do |log|
+     log.extend(File::Tail)
+     log.backward(10)
+     log.tail { |line| puts line }
+   end
+   ```
+
+2. **Logfile Convenience Class** - Using the Logfile wrapper for simpler usage:
+   ```ruby
+   File::Tail::Logfile.tail('app.log', :backward => 10) do |line|
+     puts line
+   end
+   ```
 
 ## Installation
 
 To install file-tail via its gem type:
 
-# gem install file-tail
+```bash
+gem install file-tail
+```
+
+You can also put this line into your Gemfile:
+
+```ruby
+gem 'file-tail'
+```
+
+and bundle. This will make the File::Tail module available for extending File objects.
 
 ## Usage
 
 File::Tail is a module in the File class. A lightweight class interface for
 logfiles can be seen under File::Tail::Logfile.
 
-Direct extension of File objects with File::Tail works like that:
+### Direct Extension of File Objects
+
+```ruby
+File.open(filename) do |log|
+  log.extend(File::Tail)
+  log.interval # 10
+  log.backward(10)
+  log.tail { |line| puts line }
+end
+```
+
+It's also possible to mix File::Tail in your own File classes (see also File::Tail::Logfile):
 
-    File.open(filename) do |log|
-      log.extend(File::Tail)
-      log.interval # 10
-      log.backward(10)
-      log.tail { |line| puts line }
-    end
+```ruby
+class MyFile < File
+  include File::Tail
+end
+log = MyFile.new("myfile")
+log.interval # 10
+log.backward(10)
+log.tail { |line| print line }
+```
 
-It's also possible to mix File::Tail in your own File classes
-(see also File::Tail::Logfile):
+The forward/backward method returns self, so it's possible to chain methods together like that:
 
-    class MyFile < File
-      include File::Tail
-    end
-    log # MyFile.new("myfile")
-    log.interval # 10
-    log.backward(10)
-    log.tail { |line| print line }
+```ruby
+log.backward(10).tail { |line| puts line }
+```
 
-The forward/backward method returns self, so it's possible to chain
-methods together like that:
+### Multiple File Tailing with Group
 
-    log.backward(10).tail { |line| puts line }
+```ruby
+group = File::Tail::Group.new
+group.add_filename('app.log')
+group.add_filename('error.log')
+group.tail { |line| puts line }
+```
 
-A command line utility named rtail, that uses File::Tail is provided as well.
+### Advanced Usage with Callbacks
+
+```ruby
+log = File::Tail::Logfile.open('app.log')
+log.after_reopen { |file| puts "File reopened: #{file.path}" }
+log.tail { |line| puts line }
+```
+
+### Backward Traversal
+
+```ruby
+# Tail last 10 lines of file
+File::Tail::Logfile.open('app.log', :backward => 10) do |log|
+  log.tail { |line| puts line }
+end
+
+# Skip first 5 lines and tail
+File::Tail::Logfile.open('app.log', :forward => 5) do |log|
+  log.tail { |line| puts line }
+end
+```
 
 ## Documentation
 
 To create the documentation of this module, type
 
-```
+```bash
 $ rake doc
 ```
 
 and the API documentation is generated.
 
-In the examples direcotry is a small example of tail and
+In the examples directory is a small example of tail and
 pager program that use this module. You also may want look
 at the end of examples/tail.rb for a little example.
 
+## Debugging and Troubleshooting
+
+File::Tail provides built-in debugging capabilities through environment variables:
+
+### Enabling Debug Output
+
+Set the `FILE_TAIL_DEBUG` environment variable to enable detailed debugging information:
+
+```bash
+export FILE_TAIL_DEBUG=1
+ruby your_tail_script.rb
+```
+
+This will output information about:
+- File paths being tailed
+- Line counts and intervals
+- Reopening events
+- Sleep intervals and timing
+
+### Exception Handling
+
+File::Tail defines several specific exceptions for different failure scenarios:
+
+```ruby
+begin
+  log.tail { |line| puts line }
+rescue File::Tail::DeletedException
+  # Handle file deletion
+rescue File::Tail::ReopenException
+  # Handle file rotation/reopening
+rescue File::Tail::BreakException
+  # Handle end-of-file with break_if_eof set
+rescue File::Tail::ReturnException
+  # Internal exception for controlling tailing behavior
+end
+```
+
+## Configuration
+
+### Key Attributes
+
+File::Tail provides several configurable attributes for fine-tuning behavior:
+
+```ruby
+log = File::Tail::Logfile.open('app.log')
+log.interval = 1.0           # Initial sleep interval (default: 10)
+log.max_interval = 5.0       # Maximum sleep interval (default: 10)
+log.reopen_deleted = true    # Reopen deleted files (default: true)
+log.reopen_suspicious = true # Reopen on suspicious events (default: true)
+log.suspicious_interval = 60 # Interval before suspicious event detection (default: 60)
+log.break_if_eof = false     # Break on EOF (default: false)
+log.return_if_eof = false    # Return on EOF (default: false)
+```
+
+### Advanced Configuration
+
+```ruby
+# Configure for high-traffic logs
+log.interval = 0.1
+log.max_interval = 1.0
+log.suspicious_interval = 30
+
+# Configure for low-traffic logs
+log.interval = 5.0
+log.max_interval = 30.0
+log.suspicious_interval = 120
+```
+
+## Performance Considerations
+
+### Thread Safety
+
+File::Tail uses thread-safe mechanisms for concurrent file monitoring:
+- ThreadGroup for managing tailer threads
+- Mutex and ConditionVariable for synchronization
+- Queue-based line buffering for thread communication
+
+### Memory Management
+
+The library implements efficient memory usage:
+- Lines are buffered in queues per tailer
+- Exponential backoff reduces CPU usage when files are quiet
+- Proper thread lifecycle management prevents resource leaks
+
+### File System Event Handling
+
+File::Tail gracefully handles various file system events:
+- File rotation (log rotation)
+- File truncation
+- File deletion
+- File reopening after deletion
+
+## Error Handling
+
+File::Tail provides comprehensive error handling for common file system scenarios:
+
+### File::Tail Exception Hierarchy
+
+```mermaid
+classDiagram
+    class TailException {
+        <<abstract>>
+        +message
+    }
+
+    class DeletedException
+    class ReturnException
+    class BreakException
+    class ReopenException
+
+    TailException <|-- DeletedException
+    TailException <|-- ReturnException
+    TailException <|-- BreakException
+    TailException <|-- ReopenException
+```
+
+### Safe Usage Pattern
+
+```ruby
+def safe_tail(filename)
+  File::Tail::Logfile.open(filename) do |log|
+    log.tail { |line| puts line }
+  rescue File::Tail::DeletedException
+    puts "File was deleted, stopping tailing"
+  rescue File::Tail::ReopenException
+    puts "File reopened, continuing tailing"
+  end
+end
+```
+
+## Download
+
+The latest version of *File::Tail* (file-tail) can be found at
+
+https://github.com/flori/file-tail
+
 ## Author
 
 Florian Frank mailto:flori@ping.de
 
 ## License
 
-Apache License, Version 2.0 – See the COPYING file in the source archive.
+This software is licensed under the [Apache 2.0 license](LICENSE).

data/Rakefile

@@ -11,12 +11,23 @@ GemHadar do
   summary     "#{path_name.camelize} for Ruby"
   description 'Library to tail files in Ruby'
   test_dir    'tests'
-  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '*.rbc', '.rbx', '.AppleDouble', '.bundle'
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '*.rbc', '.rbx',
+    '.AppleDouble', '.bundle', 'errors.lst', '.utilsrc', 'tmp', '.yardoc'
   readme      'README.md'
   licenses    << 'Apache-2.0'
 
+  changelog do
+    filename 'CHANGES.md'
+  end
+
+  github_workflows(
+    'static.yml' => {}
+  )
 
   dependency  'tins', '~>1.0'
 
-  development_dependency 'test-unit', '~>2.4.0'
+  development_dependency 'test-unit', '~>3.0'
+  development_dependency 'all_images'
+  development_dependency 'simplecov'
+  development_dependency 'debug'
 end

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.4.0

data/bin/rtail

@@ -39,7 +39,7 @@ end
 
 add_logfiles logfiles
 
-t = Thread.new do
+Thread.new do
   $logfiles.tail do |line|
     if $opt['M']
       puts "#{line.file.path}: #{line}"

data/file-tail.gemspec

@@ -1,40 +1,31 @@
 # -*- encoding: utf-8 -*-
-# stub: file-tail 1.2.0 ruby lib
+# stub: file-tail 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "file-tail".freeze
-  s.version = "1.2.0"
+  s.version = "1.4.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2017-04-13"
+  s.date = "1980-01-02"
   s.description = "Library to tail files in Ruby".freeze
   s.email = "flori@ping.de".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/file-tail.rb".freeze, "lib/file/tail.rb".freeze, "lib/file/tail/group.rb".freeze, "lib/file/tail/line_extension.rb".freeze, "lib/file/tail/logfile.rb".freeze, "lib/file/tail/tailer.rb".freeze, "lib/file/tail/version.rb".freeze]
-  s.files = [".gitignore".freeze, ".travis.yml".freeze, "CHANGES".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rtail".freeze, "examples/pager.rb".freeze, "examples/tail.rb".freeze, "file-tail.gemspec".freeze, "lib/file-tail.rb".freeze, "lib/file/tail.rb".freeze, "lib/file/tail/group.rb".freeze, "lib/file/tail/line_extension.rb".freeze, "lib/file/tail/logfile.rb".freeze, "lib/file/tail/tailer.rb".freeze, "lib/file/tail/version.rb".freeze, "tests/file_tail_group_test.rb".freeze, "tests/file_tail_test.rb".freeze, "tests/test_helper.rb".freeze]
+  s.files = [".all_images.yml".freeze, ".github/workflows/static.yml".freeze, ".gitignore".freeze, ".travis.yml".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rtail".freeze, "examples/pager.rb".freeze, "examples/tail.rb".freeze, "file-tail.gemspec".freeze, "lib/file-tail.rb".freeze, "lib/file/tail.rb".freeze, "lib/file/tail/group.rb".freeze, "lib/file/tail/line_extension.rb".freeze, "lib/file/tail/logfile.rb".freeze, "lib/file/tail/tailer.rb".freeze, "lib/file/tail/version.rb".freeze, "tests/file_tail_group_test.rb".freeze, "tests/file_tail_test.rb".freeze, "tests/test_helper.rb".freeze, "tmp/.gitkeep".freeze]
   s.homepage = "http://github.com/flori/file-tail".freeze
   s.licenses = ["Apache-2.0".freeze]
   s.rdoc_options = ["--title".freeze, "File-tail - File::Tail for Ruby".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "2.6.11".freeze
+  s.rubygems_version = "4.0.2".freeze
   s.summary = "File::Tail for Ruby".freeze
   s.test_files = ["tests/file_tail_group_test.rb".freeze, "tests/file_tail_test.rb".freeze, "tests/test_helper.rb".freeze]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.specification_version = 4
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-      s.add_development_dependency(%q<test-unit>.freeze, ["~> 2.4.0"])
-      s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.0"])
-    else
-      s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-      s.add_dependency(%q<test-unit>.freeze, ["~> 2.4.0"])
-      s.add_dependency(%q<tins>.freeze, ["~> 1.0"])
-    end
-  else
-    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-    s.add_dependency(%q<test-unit>.freeze, ["~> 2.4.0"])
-    s.add_dependency(%q<tins>.freeze, ["~> 1.0"])
-  end
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.16.3".freeze])
+  s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.0".freeze])
+  s.add_development_dependency(%q<all_images>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.0".freeze])
 end

data/lib/file/tail/logfile.rb

@@ -51,7 +51,7 @@ class File
         end
         if backward = opts[:backward] || opts[:rewind]
           (args = []) << backward
-          args << opt[:bufsiz] if opts[:bufsiz]
+          args << opts[:bufsiz] if opts[:bufsiz]
           file.backward(*args)
         elsif forward = opts[:forward] || opts[:wind]
           file.forward(forward)
@@ -64,7 +64,6 @@ class File
             block.call file
           ensure
             file.close
-            nil
           end
         else
           file

data/lib/file/tail/version.rb

@@ -1,6 +1,6 @@
 module File::Tail
   # File::Tail version
-  VERSION         = '1.2.0'
+  VERSION         = '1.4.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/file/tail.rb

@@ -17,7 +17,7 @@ class File
     class DeletedException < TailException; end
 
     # The ReturnException is raised and caught
-    # internally to implement "tail -10" behaviour.
+    # internally to implement "tail -10" behavior.
     class ReturnException < TailException; end
 
     # The BreakException is raised if the <code>break_if_eof</code>
@@ -26,7 +26,7 @@ class File
     class BreakException < TailException; end
 
     # The ReopenException is raised internally if File::Tail
-    # gets suspicious something unusual has happend to
+    # gets suspicious something unusual has happened to
     # the tailed file, e. g., it was rotated away. The exception
     # is caught and an attempt to reopen it is made.
     class ReopenException < TailException
@@ -66,14 +66,14 @@ class File
     attr_accessor :reopen_suspicious
 
     # The callback is called with _self_ as an argument after a reopen has
-    # occured. This allows a tailing script to find out, if a logfile has been
-    # rotated.
+    # occurred. This allows a tailing script to find out, if a logfile has
+    # been rotated.
     def after_reopen(&block)
       @after_reopen = block
     end
 
-    # This attribute is the invterval in seconds before File::Tail
-    # gets suspicious that something has happend to it's tailed file
+    # This attribute is the interval in seconds before File::Tail
+    # gets suspicious that something has happened to it's tailed file
     # and an attempt to reopen it is made.
     #
     # If the attribute <code>reopen_suspicious</code> is
@@ -241,16 +241,18 @@ class File
       if @stat
         if stat.ino != @stat.ino or stat.dev != @stat.dev
           @stat = nil
-          raise ReopenException.new(:top)
+          raise ReopenException.new(:top) # File ino/dev has changed, start from top
         end
         if stat.size < @stat.size
           @stat = nil
-          raise ReopenException.new(:top)
+          raise ReopenException.new(:top) # File shrunk, start from top
         end
       end
       @stat = stat
-    rescue Errno::ENOENT, Errno::ESTALE
-      raise ReopenException
+    rescue Errno::ENOENT
+      raise ReopenException.new(:top) # File was missing, maybe it has been rotated, start from top
+    rescue Errno::ESTALE
+      raise ReopenException # File is stale let's try opening again with same mo
     end
 
     def sleep_interval
@@ -272,7 +274,7 @@ class File
     end
 
     def reopen_file(mode)
-      $DEBUG and $stdout.print "Reopening '#{path}', mode = #{mode}.\n"
+      debug? and $stdout.print "Reopening '#{path}', mode = #{mode}.\n"
       @no_read = 0
       reopen(path)
       if mode == :bottom
@@ -290,7 +292,7 @@ class File
     end
 
     def output_debug_information
-      $DEBUG or return
+      debug? or return
       STDERR.puts({
         :path     => path,
         :lines    => @lines,
@@ -300,6 +302,10 @@ class File
       }.inspect)
       self
     end
+
+    def debug?
+      ENV['FILE_TAIL_DEBUG'].to_i == 1
+    end
   end
 end
 

data/tests/file_tail_test.rb

@@ -4,13 +4,16 @@ require 'test_helper'
 require 'file/tail'
 require 'timeout'
 require 'thread'
+require 'fileutils'
 Thread.abort_on_exception = true
 
 class FileTailTest < Test::Unit::TestCase
   include File::Tail
+  include FileUtils
 
   def setup
-    @out = File.new("test.#$$", "wb")
+    @out = File.new(File.join('tmp', "test.#$$"), "wb")
+    at_exit { path = @out&.path and rm_f File.expand_path(path) }
     append(@out, 100)
     @in = File.new(@out.path, "rb")
     @in.extend(File::Tail)
@@ -194,7 +197,7 @@ class FileTailTest < Test::Unit::TestCase
     lines = []
     logger = Thread.new do
       begin
-        Timeout::timeout(2) do
+        Timeout::timeout(10) do
           @in.tail do |l|
             lines << l
           end
@@ -225,7 +228,7 @@ class FileTailTest < Test::Unit::TestCase
     lines = []
     logger = Thread.new do
       begin
-        Timeout::timeout(2) do
+        Timeout::timeout(10) do
           @in.tail do |l|
             lines << l
           end
@@ -261,7 +264,7 @@ class FileTailTest < Test::Unit::TestCase
     lines = []
     logger = Thread.new do
       begin
-        Timeout::timeout(2) do
+        Timeout::timeout(10) do
           @in.tail(15) do |l|
             lines << l
           end
@@ -298,7 +301,7 @@ class FileTailTest < Test::Unit::TestCase
     lines = []
     logger = Thread.new do
       begin
-        Timeout::timeout(2) do
+        Timeout::timeout(10) do
           @in.tail(110) do |l|
             lines << l
           end
@@ -307,8 +310,10 @@ class FileTailTest < Test::Unit::TestCase
       end
     end
     appender = Thread.new do
-      until logger.stop?
-        sleep 0.1
+      Timeout::timeout(10) do
+        until lines.size == 100
+          sleep 0.1
+        end
       end
       @out.close
       File.unlink(@out.path)
@@ -331,7 +336,7 @@ class FileTailTest < Test::Unit::TestCase
     lines = []
     logger = Thread.new do
       begin
-        Timeout::timeout(2) do
+        Timeout::timeout(10) do
           @in.tail(110) do |l|
             lines << l
           end
@@ -340,8 +345,10 @@ class FileTailTest < Test::Unit::TestCase
       end
     end
     appender = Thread.new do
-      until logger.stop?
-        sleep 0.1
+      Timeout::timeout(10) do
+        until lines.size == 100
+          sleep 0.1
+        end
       end
       @out.truncate 0
       @out.close

metadata

@@ -1,43 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: file-tail
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Florian Frank
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 2.16.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 2.16.3
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: all_images
+  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: simplecov
+  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: debug
+  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: tins
   requirement: !ruby/object:Gem::Requirement
@@ -66,11 +107,13 @@ extra_rdoc_files:
 - lib/file/tail/tailer.rb
 - lib/file/tail/version.rb
 files:
+- ".all_images.yml"
+- ".github/workflows/static.yml"
 - ".gitignore"
 - ".travis.yml"
-- CHANGES
-- COPYING
+- CHANGES.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - VERSION
@@ -88,11 +131,11 @@ files:
 - tests/file_tail_group_test.rb
 - tests/file_tail_test.rb
 - tests/test_helper.rb
+- tmp/.gitkeep
 homepage: http://github.com/flori/file-tail
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options:
 - "--title"
 - File-tail - File::Tail for Ruby
@@ -111,9 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 4.0.2
 specification_version: 4
 summary: File::Tail for Ruby
 test_files:

data/CHANGES

@@ -1,82 +0,0 @@
-2016-04-19 * 1.2.0 * Make line separator configurable
-2016-04-19 * 1.1.1 * Fix tests on Ruby 2.3.0
-2014-09-26 * 1.1.0 * Depend on tins ~ 1.0
-2012-05-31 * 1.0.10 * Use rewind to force IO#lineno to be reset.
-2012-05-31 * 1.0.9 * Reopen file in :top mode at the beginning.
-2011-12-24 * 1.0.8 * Support simplecov.
-2011-07-15 * 1.0.7 * Use gem_hadar to shorten Rakefile.
-2011-06-25 * 1.0.6 * Create a gem spec file again.
-                   * Added a File::Tail::Group to tail multiple files more easily.
-2010-03-25 * 1.0.5 * Added rtail executable, a nice app to supervise logfiles
-                     and logdirs.
-                   * Disabled creation of gem spec file.
-                   * Cleaned up documentation a bit.
-2009-08-21 * 1.0.4 * Fixed the threaded tests for Ruby 1.9.
-                   * Create a gem spec file.
-                   * Some cleanup.
-2008-04-07 * 1.0.3 * Danny Colligan <danny.colligan@sendori.com> reported a
-                     memory leak in long running scripts using file-tail. I
-                     think this might be a ruby related problem, which is
-                     caused/aggravated by using yield after having &block
-                     parameter in a method. I changed file-tail to only use
-                     block.call, which seems to improve the memory behaviour. I
-                     am still not sure, where the problem actually stems
-                     from, though.
-2007-04-19 * 1.0.2 * make_doc.rb was missing from the source archive. Thanks to
-                     Rick Ohnemus <rick.ohnemus@systemware.com> for reporting it.
-2007-04-19 * 1.0.1 * Bugfix: File::Tail::Logfile#open with block, now closes
-                     the file like File#open does. Found by Alex Doan
-                     <alex.doan@wachovia.com>, ruby-talk:248383.
-2007-03-30 * 1.0.0 * Bugfix: David.Barzilay@swisscom.com reported, that file
-                     tails may skip some log file lines, after rotating it. I
-                     think, that I fixed that problem.
-                     I added a after_reopen callback as well, that is called
-                     after reopening of the tailed file has occured.
-                   * Removed rewind/wind methods even earlier than planned: I
-                     placed the deprecation warning for rewind method in File
-                     instead of File::Tail, which caused rewind to stop working
-                     completely after loading file/tail. Duh! I blame vim's
-                     matchit, because it jumped to the wrong end keyword.
-2007-02-08 * 0.1.4 * Renamed rewind method to backward, and wind method to
-                     forward, because someone already had the good idea to name
-                     a method IO#rewind, which was overwritten by the mixed in
-                     File::Tail methods. The old methods are now deprecated and
-                     will be removed in a new 0.2.x version of the library.
-                   * Added a bit more of documentation.
-2005-08-20 * 0.1.3 * Applied LOAD_PATH  patch by Daniel Berger, binary mode
-                     changes were already in the CVS. Seemed to be like cheating
-                     to me, though. ;)
-                   * Skipping one windows test for the moment, too. Sigh!
-2004-09-30 * 0.1.2 * First Rubyforge release
-                   * Added Rakefile
-                   * Supports gem build now.
-2004-09-01 * 0.1.1 * Josh Endries <josh@endries.org> found a bug
-                     that caused File::Tail to malfunction on FreeBSD.
-                     Hotfix: Use a side effect of seek to clearerr the tailed
-                     file handle after EOFError has been raised.
-2004-04-13 * 0.1.0 * API documentation with rdoc.
-                   * return_if_eof attribute added.
-                   * Added array return mode for finite tail call without block
-                     given.
-                   * install.rb now uses ruby version site_dir.
-                   * Some code and directory structure cleanup.
-2002-08-02 * 0.0.2 * Heavy refactoring, more and smaller methods
-                     and expception handling
-                   * Added check for inode and device equality of files
-                     as suggested by
-                     James F.Hranicky <jfh@cise.ufl.edu> and
-                     Curt Sampson  <cjs@cynic.net> to cover remove
-                     rotation
-                   * If filesize shrinks suddenly, File::Tail assumes that
-                     copy and truncate rotation has happend: The file
-                     is reopened and every new line is handled.
-                   * NFS-Fix: Errno::ESTALE is caught.
-                   * wind added to skip the first n lines, as
-                     James F.Hranicky's suggested and changed
-                     name of last-method to rewind, because I liked
-                     his method names better than mine ;)
-                   * Renamed next to tail either.
-                   * The API has changed - but I think very few people
-                     care at the moment.
-                   * Lots of tests added.
-2002-07-30 * 0.0.1 * Initial Release