tayle 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c3659dae92c4938d1fcd1b672acdaae573381d210e53c760960dac3ba03fe91
-  data.tar.gz: f0a81610b40f35d0aae755aebd0e48f87eee4facc711cc8bad4167b8ebc5bfa2
+  metadata.gz: a65760090afbdffc216ac783b3d12eabb027d12cfc5e7400562c5bce648fecc2
+  data.tar.gz: 9472e410596c4cd47414279c191655731792626d4460be0defa6e3dd5e333dc2
 SHA512:
-  metadata.gz: 315cec2e7111c0e0ce81ee01df7fe0c15cb96e24b7f9d778214dcdd45d3d6f3e8a6bde57111ba85d08105425410d223987f2eb17f2d4d1418a0c0da5d24f7937
-  data.tar.gz: e5f7be6634d58b59df2dc222476b136ba481c388f7f022bad00a8f64240ef08442a9f937c9958568709e3e932cb160df8db39cfd257a85495fc1e8549934f956
+  metadata.gz: 1758346dbb7deb61cfcc5d2497bb475b7215fbb37568823ef1b2471af4a0a8160411eeb3e1107c299fa852cd07b4518721739d6499e6944275eac864e88783ea
+  data.tar.gz: 88c85b7d0bc9b67cc40d653a26c0e76c2fc5d39d5cc5226c3ea36662adda266e2ca4484198278ce73a111a32a41085d80f4b39cfd4f0d9fbe152b928e6a144c2

data/.rubocop.yml

@@ -16,7 +16,7 @@ plugins:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 4.0
+  TargetRubyVersion: 3.4
   Exclude:
     - bin/*
     - vendor/**/*

data/README.md

@@ -27,7 +27,7 @@ Pass `position: :start` to read what the log already holds first, `writer_pid:`
 to stop once the process writing it does, and `tail_path:` to run a `tail`
 other than the first on `PATH`. See the rdoc on `Tayle` for the details.
 
-Requires GNU coreutils `tail` 8.28 or newer; anything else raises
+Requires Ruby 3.4.10 or newer and GNU coreutils `tail` 8.28 or newer; any other `tail` raises
 `Tayle::Unsupported`.
 
 ## Development

data/Rakefile

@@ -7,10 +7,13 @@ RSpec::Core::RakeTask.new(:spec)
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-require "gempilot/version_task"
-Gempilot::VersionTask.new
+# gempilot needs Ruby 4.0, so the Gemfile leaves it out on 3.4 and these tasks go with it.
+if Gem.loaded_specs.key?("gempilot")
+  require "gempilot/version_task"
+  Gempilot::VersionTask.new
 
-require "gempilot/zeitwerk_task"
-Gempilot::ZeitwerkTask.new
+  require "gempilot/zeitwerk_task"
+  Gempilot::ZeitwerkTask.new
+end
 
 task default: [:spec, :rubocop]

data/lib/tayle/version.rb

@@ -1,3 +1,3 @@
 class Tayle
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/tayle.rb

@@ -1,3 +1,4 @@
+require "pathname"
 require "zeitwerk"
 
 ##

data/rakelib/rbs.rake

@@ -0,0 +1,61 @@
+require "yaml"
+
+namespace :rbs do
+  root_dir = Pathname(__dir__).parent
+  collection_yaml = root_dir / "rbs_collection.yaml"
+  collection_dir = root_dir / ".gem_rbs_collection"
+  manifest = root_dir / "sig" / "manifest.yaml"
+
+  # The stdlib signatures sig/manifest.yaml names, as rbs -r flags; the
+  # manifest only applies by itself when the gem's sig is loaded as a library.
+  stdlib_flags = lambda do
+    YAML.safe_load_file(manifest).fetch("dependencies").flat_map { ["-r", it.fetch("name")] }
+  end
+
+  desc "Install the rbs collection rbs_collection.lock.yaml pins"
+  task setup: ["rbs:collection:install"]
+
+  desc "Remove the installed rbs collection"
+  task :clobber do
+    rm_rf collection_dir
+  end
+
+  desc "Check every signature under sig parses and names only types that exist"
+  task validate: ["rbs:collection:install"] do
+    sh "bundle", "exec", "rbs", "-I", "sig", *stdlib_flags.call, "validate"
+  end
+
+  # Enumerators go unchecked: the checker samples one by iterating, and the
+  # Enumerator #each returns blocks on tail until the log grows.
+  desc "Run the specs with every Tayle call checked against its signature"
+  task test: ["rbs:collection:install"] do
+    env = {
+      "RBS_TEST_TARGET" => "Tayle,Tayle::*",
+      "RBS_TEST_OPT" => ["-I", "sig", *stdlib_flags.call].join(" "),
+      "RBS_TEST_LOGLEVEL" => "warn",
+      "RBS_TEST_DOUBLE_SUITE" => "rspec",
+      "RBS_TEST_UNCHECKED_CLASSES" => "Enumerator",
+      "RUBYOPT" => "-r rbs/test/setup",
+    }
+    sh env, "bundle", "exec", "rspec"
+  end
+
+  namespace :collection do
+    file collection_yaml.to_s do
+      sh "bundle exec rbs collection init"
+    end
+
+    desc "Write rbs_collection.yaml if it is missing"
+    task init: [collection_yaml.to_s]
+
+    desc "Install the gem RBS files the collection lists"
+    task install: ["rbs:collection:init"] do
+      sh "bundle exec rbs collection install"
+    end
+
+    desc "Re-resolve the collection and rewrite rbs_collection.lock.yaml"
+    task :update do
+      sh "bundle exec rbs collection update"
+    end
+  end
+end

data/sig/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: pathname

data/sig/tayle/command.rbs

@@ -0,0 +1,26 @@
+class Tayle
+  # Private constants; RBS has no private_constant.
+  POSITIONS: Array[position]
+
+  # The tail invocation: argv for one path, writer and start position.
+  class Command < Data
+    attr_reader executable: Pathname
+    attr_reader path: Pathname
+    attr_reader writer: Writer?
+    attr_reader position: position
+
+    def self.new: (executable: Pathname, path: String | Pathname, writer: Writer?, position: position) -> instance
+                | (Pathname executable, String | Pathname path, Writer? writer, position position) -> instance
+
+    def self.members: () -> [:executable, :path, :writer, :position]
+
+    # Raises ArgumentError for any Symbol but :start or :end.
+    def initialize: (executable: Pathname, path: String | Pathname, writer: Writer?, position: Symbol) -> void
+
+    def argv: () -> Array[String]
+
+    private
+
+    def first_byte: () -> Integer
+  end
+end

data/sig/tayle/gnu_tail.rbs

@@ -0,0 +1,22 @@
+class Tayle
+  OLDEST_SUPPORTED_VERSION: [Integer, Integer]
+
+  # A located tail executable and its coreutils version, nil when not GNU.
+  class GnuTail < Data
+    attr_reader executable: Pathname
+    attr_reader version: [Integer, Integer]?
+
+    def self.new: (executable: Pathname, version: [Integer, Integer]?) -> instance
+                | (Pathname executable, [Integer, Integer]? version) -> instance
+
+    def self.members: () -> [:executable, :version]
+
+    def self.locate: (String | Pathname command) -> instance
+
+    private def self.list_candidates: (String | Pathname command) -> Array[Pathname]
+
+    private def self.read_version: (Pathname executable) -> [Integer, Integer]?
+
+    def check_supported: () -> void
+  end
+end

data/sig/tayle/version.rbs

@@ -0,0 +1,3 @@
+class Tayle
+  VERSION: String
+end

data/sig/tayle/writer.rbs

@@ -0,0 +1,17 @@
+class Tayle
+  # The process writing the log; tail --pid exits once it is reaped.
+  class Writer < Data
+    attr_reader pid: Integer
+
+    def self.new: (pid: Integer | String) -> instance
+                | (Integer | String pid) -> instance
+
+    def self.members: () -> [:pid]
+
+    def initialize: (pid: Integer | String) -> void
+
+    def flag: () -> String
+
+    def gone?: () -> bool
+  end
+end

data/sig/tayle.rbs

@@ -0,0 +1,39 @@
+class Tayle
+  include Enumerable[String]
+
+  # Where reading begins: the file's current end, or its first byte.
+  type position = :start | :end
+
+  LOADER: Zeitwerk::GemLoader
+
+  class Unsupported < StandardError
+  end
+
+  class Exited < StandardError
+    # nil if something else reaped tail first.
+    attr_reader status: Process::Status?
+
+    def initialize: (status: Process::Status?) -> void
+  end
+
+  attr_reader lines_read: Integer
+
+  # Any Symbol reaches Command, which raises ArgumentError unless it is :start or :end;
+  # writer_pid is coerced with Integer(), so a non-numeric String raises the same.
+  def initialize: (String | Pathname path, ?writer_pid: (Integer | String)?, ?tail_path: String | Pathname, ?position: Symbol) ?{ (Tayle) -> void } -> void
+
+  def path: () -> Pathname
+
+  def position: () -> position
+
+  def each: (?chomp: bool) { (String) -> void } -> self
+          | (?chomp: bool) -> Enumerator[String, self]
+
+  alias each_line each
+
+  def close: () -> void
+
+  private
+
+  def yield_and_close: [T] () { (Tayle) -> T } -> T
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tayle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - David Gillis
@@ -40,6 +40,13 @@ files:
 - lib/tayle/gnu_tail.rb
 - lib/tayle/version.rb
 - lib/tayle/writer.rb
+- rakelib/rbs.rake
+- sig/manifest.yaml
+- sig/tayle.rbs
+- sig/tayle/command.rbs
+- sig/tayle/gnu_tail.rbs
+- sig/tayle/version.rbs
+- sig/tayle/writer.rbs
 licenses:
 - MIT
 metadata:
@@ -51,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 4.0.6
+      version: 3.4.10
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="