cruise 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb4d8ff794d947b973ff33779fdb29414d254a2960d8789ff8051b8323481134
-  data.tar.gz: 12510283a397763ea9b33152884e5c1a2082fb0ed25ee5b35daf7ca6659b4826
+  metadata.gz: 56816599df213ccbde29d06aa61ef5c29ab1dfc804f499be0f0d0459f5323872
+  data.tar.gz: d9392f2285f1232cefb6fb77673e974b0f2f602575002241f5573b8c7210b335
 SHA512:
-  metadata.gz: ffd8d400b7e194c945ce3d1fbf9728d45cdb9b47b0654c80eb5abd109144de5e8ba1040d7a845ee9e08bd44334127c2fea30941158013e81d5302a022b202b3e
-  data.tar.gz: '0993a6184ed81d6d4bb00f6ff0b1d9d89d5dc27e00b333d4a950dc96d7eb8b0efe0d55b375e73fd8c460e0c3c2378169205ca9e725d1672dd18a4fd1acde0c04'
+  metadata.gz: 639275228d40ed88daf1b4a6cf805133b7122aaad93ba06e68a5bca72854a816c1d246bb60e17cc6b6bda6aac00f5e24622e0a40d988959f7fc1f65b73e224e0
+  data.tar.gz: 1b5dd3b61fbeef8b6f96c35613d7c17b42cc81d887929131199b6c022024cd452f2821c7510b1be41657ab86232e5baf144860a644b1dbd3ce2bedc3aa10978e

data/Cargo.lock

@@ -143,7 +143,7 @@ checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570"
 
 [[package]]
 name = "cruise"
-version = "0.2.0"
+version = "0.2.1"
 dependencies = [
  "cbindgen",
  "globset",

data/Rakefile

@@ -85,5 +85,15 @@ rescue LoadError => e
   end
 end
 
+desc "Generate RBS signatures from the inline annotations"
+task :rbs do
+  sh "bundle exec rbs-inline --opt-out --output=sig/ lib/"
+end
+
+desc "Type check with Steep"
+task :steep do
+  sh "bundle exec steep check"
+end
+
 task test: :compile
-task default: [:compile, :test]
+task default: [:compile, :test, :steep]

data/cruise.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
     "Cargo.lock",
     "Rakefile",
     "lib/**/*.rb",
+    "sig/**/*.rbs",
     "ext/cruise/build.rs",
     "ext/cruise/Cargo.toml",
     "ext/cruise/cbindgen.toml",

data/ext/cruise/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cruise"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 authors = ["Marco Roth <marco.roth@intergga.ch>"]
 description = "A fast, OS-native file watcher for Ruby"

data/lib/cruise/event.rb

@@ -2,17 +2,21 @@
 
 module Cruise
   class Event
-    attr_reader :path, :kind
+    attr_reader :path #: String
+    attr_reader :kind #: String
 
+    #: (String path, String kind) -> void
     def initialize(path, kind)
       @path = path
       @kind = kind
     end
 
+    #: () -> String
     def inspect
       "#<Cruise::Event kind=#{kind.inspect} path=#{path.inspect}>"
     end
 
+    #: () -> String
     def to_s
       "#{kind}: #{path}"
     end

data/lib/cruise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cruise
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/cruise/watcher.rb

@@ -2,31 +2,36 @@
 
 module Cruise
   class Watcher
+    #: (*paths paths, ?glob: globs?, ?debounce: debounce, ?only: kinds?) -> void
     def initialize(*paths, glob: nil, debounce: DEFAULT_DEBOUNCE, only: nil)
       paths = paths.flatten.grep(String)
 
       raise ArgumentError, "Cruise::Watcher requires at least one path" if paths.empty?
 
-      glob_patterns = glob ? Array(glob) : []
-      only_kinds = only ? Array(only).map(&:to_s) : []
+      glob_patterns = glob ? Array(glob) : [] #: Array[String]
+      only_kinds = only ? Array(only).map(&:to_s) : [] #: Array[String]
 
       initialize_native(paths, debounce.to_f, glob_patterns, only_kinds)
     end
 
+    #: () -> IO
     def io
       raise NotImplementedError, "Cruise::Watcher#io is provided by the native extension"
     end
 
+    #: () -> Event?
     def poll
       raise NotImplementedError, "Cruise::Watcher#poll is provided by the native extension"
     end
 
+    #: () -> void
     def close
       raise NotImplementedError, "Cruise::Watcher#close is provided by the native extension"
     end
 
     private
 
+    #: (Array[String] paths, Float debounce, Array[String] globs, Array[String] only_kinds) -> void
     def initialize_native(_paths, _debounce, _globs, _only_kinds)
       raise NotImplementedError, "Cruise::Watcher#initialize_native is provided by the native extension"
     end

data/lib/cruise.rb

@@ -7,7 +7,7 @@ require_relative "cruise/event"
 require_relative "cruise/watcher"
 
 begin
-  ruby_version = RUBY_VERSION.split(".")[0..1].join(".")
+  ruby_version = RUBY_VERSION.split(".").take(2).join(".")
 
   begin
     require "cruise/#{ruby_version}/cruise"
@@ -19,7 +19,7 @@ rescue LoadError => e
 end
 
 module Cruise
-  DEFAULT_DEBOUNCE = 0.1
+  DEFAULT_DEBOUNCE = 0.1 #: Float
 
   class << self
     # Watch one or more paths and yield a Cruise::Event for each change.
@@ -28,6 +28,7 @@ module Cruise
     # IO#wait_readable, so this releases the GVL for other threads and, when a
     # Fiber scheduler is set (e.g. inside Async), yields to other fibers instead
     # of blocking the reactor.
+    #: (*paths paths, ?glob: globs?, ?debounce: debounce, ?only: kinds?, ?callback: callback?) ?{ (Event) -> void } -> void
     def watch(*paths, glob: nil, debounce: DEFAULT_DEBOUNCE, only: nil, callback: nil, &block)
       callback = block || callback
 
@@ -54,6 +55,7 @@ module Cruise
 
     private
 
+    #: (IO io) -> bool
     def drain_wakeups(io)
       loop { io.read_nonblock(4096) }
     rescue IO::WaitReadable

data/sig/cruise/event.rbs

@@ -0,0 +1,18 @@
+# Generated from lib/cruise/event.rb with RBS::Inline
+
+module Cruise
+  class Event
+    attr_reader path: String
+
+    attr_reader kind: String
+
+    # : (String path, String kind) -> void
+    def initialize: (String path, String kind) -> void
+
+    # : () -> String
+    def inspect: () -> String
+
+    # : () -> String
+    def to_s: () -> String
+  end
+end

data/sig/cruise/types.rbs

@@ -0,0 +1,13 @@
+# Note: This file is hand written, `rbs-inline` does not generate this file.
+
+module Cruise
+  type paths = String | Array[String]
+
+  type globs = String | Array[String]
+
+  type kinds = String | Symbol | Array[String | Symbol]
+
+  type debounce = _ToF
+
+  type callback = ^(Event) -> void
+end

data/sig/cruise/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/cruise/version.rb with RBS::Inline
+
+module Cruise
+  VERSION: ::String
+end

data/sig/cruise/watcher.rbs

@@ -0,0 +1,22 @@
+# Generated from lib/cruise/watcher.rb with RBS::Inline
+
+module Cruise
+  class Watcher
+    # : (*paths paths, ?glob: globs?, ?debounce: debounce, ?only: kinds?) -> void
+    def initialize: (*paths paths, ?glob: globs?, ?debounce: debounce, ?only: kinds?) -> void
+
+    # : () -> IO
+    def io: () -> IO
+
+    # : () -> Event?
+    def poll: () -> Event?
+
+    # : () -> void
+    def close: () -> void
+
+    private
+
+    # : (Array[String] paths, Float debounce, Array[String] globs, Array[String] only_kinds) -> void
+    def initialize_native: (Array[String] paths, Float debounce, Array[String] globs, Array[String] only_kinds) -> void
+  end
+end

data/sig/cruise.rbs

@@ -0,0 +1,17 @@
+# Generated from lib/cruise.rb with RBS::Inline
+
+module Cruise
+  DEFAULT_DEBOUNCE: Float
+
+  # Watch one or more paths and yield a Cruise::Event for each change.
+  #
+  # Blocks until interrupted. Waiting happens on the watcher's pipe via
+  # IO#wait_readable, so this releases the GVL for other threads and, when a
+  # Fiber scheduler is set (e.g. inside Async), yields to other fibers instead
+  # of blocking the reactor.
+  # : (*paths paths, ?glob: globs?, ?debounce: debounce, ?only: kinds?, ?callback: callback?) ?{ (Event) -> void } -> void
+  def self.watch: (*paths paths, ?glob: globs?, ?debounce: debounce, ?only: kinds?, ?callback: callback?) ?{ (Event) -> void } -> void
+
+  # : (IO io) -> bool
+  private def self.drain_wakeups: (IO io) -> bool
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cruise
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marco Roth
@@ -36,6 +36,11 @@ files:
 - lib/cruise/event.rb
 - lib/cruise/version.rb
 - lib/cruise/watcher.rb
+- sig/cruise.rbs
+- sig/cruise/event.rbs
+- sig/cruise/types.rbs
+- sig/cruise/version.rbs
+- sig/cruise/watcher.rbs
 homepage: https://github.com/marcoroth/cruise
 licenses:
 - MIT