cuco 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df5d2e1075b623db0450271a4535f241da3946afc2b76091653a0a5b434d3a97
+  data.tar.gz: 58c75efde02ac4b5b2637d6cc80b2e6a76589b477d7c162a84e7e6fe11aa8df8
+SHA512:
+  metadata.gz: 83a0f2b95909e51d131b8dcdf6c67cffbc7ccd9405da61bb75c0599a4f77eeef0b31425a81bc930d215524f93ddf32666b8cedcf750b6f867d388f6a95ba5308
+  data.tar.gz: 26245ecc48a0d9e4f7c19890e683944c4f2c99fb4a12840cb6e440688069583c3c74c61726bf7ac1de490715bb4e6cdd7e748f95d57e4bb5835128bc1c7c65e4

data/.github/workflows/rake.yml

@@ -0,0 +1,24 @@
+# see also https://github.com/whitequark/parser/blob/master/.github/workflows/test.yml
+name: Rake
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ["3.0", 3.3]
+        test_command: ["bundle exec rake test"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Build and test with Rake
+        run: bundle exec rake

data/.ruby-gemset

@@ -0,0 +1 @@
+rails-7.1

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.0

data/.watchr

@@ -0,0 +1,9 @@
+watch('test/.*_test\.rb$') { |md| run_it(md[0]) }
+watch('lib/(.*)\.rb$') { |md| run_it("test/#{md[1]}_test.rb") }
+
+def run_it(file)
+  system %(bundle exec ruby -I test #{file})
+end
+
+Signal.trap("QUIT") { system("bundle exec rake") } # Ctrl-\ or ctrl-4
+Signal.trap("INT") { abort("Interrupted\n") }      # Ctrl-C

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  # gem "benchmark-ips"
+  gem "minitest-spec-rails"
+  gem "ricecream"
+  gem "standard", require: false
+  gem "simplecov", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,184 @@
+PATH
+  remote: .
+  specs:
+    cuco (0.0.7)
+      listen
+      micro-optparse
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    docile (1.4.0)
+    drb (2.2.1)
+    erubi (1.12.0)
+    ffi (1.16.3)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    micro-optparse (1.2.1)
+    minitest (5.22.3)
+    minitest-spec-rails (7.2.0)
+      minitest (>= 5.0)
+      railties (>= 4.1)
+    mutex_m (0.2.0)
+    nokogiri (1.16.3-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.3-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.3-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (3.0.9.1)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.4.3)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    ricecream (0.2.1)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.35.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.62.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    stringio (3.1.0)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  cuco!
+  minitest
+  minitest-spec-rails
+  rake
+  ricecream
+  simplecov
+  standard
+
+BUNDLED WITH
+   2.5.6

data/LICENSE-MIT

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dittmar Krall (www.matiq.com)
+
+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,77 @@
+# Cuco
+
+*Cuco* watch files in a directory and take an action when they change.
+
+*Cuco* is controlled by a user-supplied script file.
+Intermixed "watch" commands specify what to do
+for the particular modified files.
+
+*Cuco* is:
+
+* Simple to use
+* Highly flexible
+* Evented               ( uses gem listen )
+* Portable              ( Ruby )
+
+Most importantly it is **agnostic** to:
+
+* Test frameworks
+* Web frameworks
+
+## Installation
+
+```ruby
+$ gem install cuco
+```
+
+## Usage
+
+```ruby
+$ cuco          # default script file is .watchr
+ Or
+$ cuco path/to/script/file
+```
+
+will monitor files in the current directory tree
+and react to events on those files in accordance with the script.
+
+## A simple example of a script file (using Minitest):
+
+```ruby
+watch( 'test/.*_test\.rb$' ) { |md| run_it(md[0]) }
+watch( 'lib/(.*)\.rb$' )     { |md| run_it("test/#{md[1]}_test.rb") }
+
+def run_it(file)
+  system %(bundle exec ruby -I test #{file})
+end
+
+Signal.trap("QUIT") { system("bundle exec rake") } # Ctrl-\ or ctrl-4
+Signal.trap("INT")  { abort("Interrupted\n") }     # Ctrl-C
+```
+
+## Script
+
+Scripts are pure Ruby.
+
+Intermixed are "watch" rules that match observed files to an action.
+The matching is achieved by a pattern (a regular expression) parameter.
+The action is specified by a block (see above sample).
+*md* is the match-data.
+
+Updates to script files are picked up on the fly (no need to restart *cuco*)
+so experimenting is painless.
+
+It's easy to see why *cuco* is so flexible,
+since the whole command is custom.
+The above actions could just as easily call "jruby", "ruby --rubygems",
+"ruby -I lib", etc. or any combination of these.
+
+## Miscellaneous
+
+*Cuco* is heavily inspired by:
+
+* gem watchr
+* gem observr (a follow-up of gem watchr)
+
+Copyright (c) 2024 Dittmar Krall (www.matiq.com),
+released under the [MIT license](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "rake"
+require "rake/testtask"
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs.push "test"
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Default: run unit tests."
+task default: :test

data/bin/cuco

@@ -0,0 +1,18 @@
+#! /usr/bin/env ruby
+
+lib = File.expand_path("../lib/", __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require "version"
+require "controller"
+require "micro-optparse"
+
+options = Parser.new do |p|
+  p.banner = "Usage: cuco [options] [.watchr] # a file watcher"
+  p.version = "cuco #{Cuco::VERSION}"
+  p.option :debug, "Debugging output", default: false
+end.process!
+
+cuco = Controller.instance
+cuco.init(options, ARGV)
+cuco.run

data/cuco.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path("../lib/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "cuco"
+  s.version = Cuco::VERSION
+  s.summary = "A file watcher"
+  s.description = "A simple and flexible file watcher"
+
+  s.authors = ["Dittmar Krall"]
+  s.email = "dittmar.krall@matiq.de"
+  s.homepage = "http://www.matiq.de"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`
+    .split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "micro-optparse"
+  s.add_dependency "listen"
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "rake"
+end

data/lib/controller.rb

@@ -0,0 +1,52 @@
+require "listen"
+require "singleton"
+require "cuco"
+require "script"
+
+class Controller
+  include Singleton
+
+  attr_reader :listener
+  attr_reader :options
+  attr_reader :pwd_size
+  attr_reader :script_name
+  attr_reader :script
+
+  def init(options, argv)
+    @options = options
+    @script_name = argv.first || ".watchr"
+    @pwd_size = Dir.pwd.size
+
+    if @options[:debug]
+      puts "options #{@options}"
+      puts "pwd     <#{@pwd}>"
+      puts "script_name <#{@script_name}>"
+    end
+  end
+
+  def run
+    stop
+    @script = Script.new
+    @script.load_file(@script_name)
+    @listener = Listen.to(".") do |modified, added, removed|
+      run_files(modified, :modified)
+      run_files(added, :added)
+    end
+
+    @listener.start
+    sleep
+  end
+
+  def stop
+    @listener&.stop
+    @script = nil
+    @listener = nil
+  end
+
+  private
+
+  def run_files(files, type)
+    files.map! { |filename| filename[@pwd_size + 1..] }
+    files.each { |filename| @script.run(filename, type) }
+  end
+end

data/lib/cuco.rb

@@ -0,0 +1 @@
+Rule = Struct.new(:pattern, :event_type, :proc)

data/lib/script.rb

@@ -0,0 +1,39 @@
+class Script
+  attr_reader :__rules
+
+  def initialize
+    reset
+  end
+
+  def load(str)
+    reset
+    instance_eval str
+  end
+
+  def load_file(filename)
+    file_data = File.read(filename)
+    load file_data
+  end
+
+  def watch(pattern, type = nil, &block)
+    @__rules << Rule.new(pattern, type, block)
+  end
+
+  def match_run(rule, pattern)
+    md = pattern.match(rule.pattern)
+    rule.proc.call(md) if md
+  end
+
+  def run(pattern, type = nil)
+    @__rules.select { |rule| match_run(rule, pattern) }
+  end
+
+  private
+
+  def reset
+    @__rules = []
+  end
+end
+
+# $ sudo sh -c "echo fs.inotify.max_user_watches=524288 >> /etc/sysctl.conf"
+# $ sudo sysctl -p

data/lib/version.rb

@@ -0,0 +1,6 @@
+module Cuco
+  VERSION = "0.0.7" # 2024-03-18
+  # VERSION = "0.0.3" # 2024-03-12
+  # VERSION = "0.0.2" # 2024-03-11
+  # VERSION = "0.0.1" # 2024-03-05
+end

data/test/controller_test.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+require "timeout"
+require "controller"
+require "script"
+
+describe Controller do
+  let(:options) { {} }
+  let(:cuco) { Controller.instance }
+  let(:script) { Script.new }
+
+  def teardown
+    cuco.stop
+  end
+
+  it "stops" do
+    cuco.stop
+    assert_nil cuco.listener
+  end
+
+  it "initializes" do
+    cuco.init(options, [])
+  end
+
+  it "runs" do
+    cuco.init(options, [])
+    assert_raises(Timeout::Error) do
+      Timeout.timeout(0.1) { cuco.run }
+    end
+
+    assert cuco.listener
+  end
+
+  it "read .watchr" do
+    filename = ".watchr"
+
+    script.load_file filename
+    assert_equal 2, script.__rules.size
+  end
+
+  private
+
+  def test_files
+    dir = File.join(Dir.pwd, "test", "files")
+    files = find_files_in(dir)
+    files.collect { |file| File.join(dir, file) }
+  end
+
+  def find_files_in(dir)
+    entries = Dir.entries(dir)
+    entries.reject { |entry| File.directory?(entry) }
+  end
+end

data/test/cuco_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+describe Cuco do
+  let(:cuco) { Controller.instance }
+
+  it "usage" do
+    out, _err = capture_io do
+      puts `bin/cuco -h`
+    end
+
+    assert_match(/Usage/, out)
+  end
+
+  it "options" do
+    options = {opt: 1234}
+    cuco.init(options, [])
+
+    assert_equal options, cuco.options
+  end
+
+  # it "coverage options debug" do
+  #   out, _err = capture_io do
+  #     puts `bin/cuco -d`
+  #     # Timeout::timeout(0.1) { puts `bin/cuco -d` }
+  #   end
+  #
+  #   assert_match(/:debug=>true/, out)
+  #   assert_match(/script  <.watchr>/, out)
+  #   assert_match(/pwd/, out)
+  # end
+end

data/test/script_test.rb

@@ -0,0 +1,53 @@
+require "test_helper"
+require "script"
+
+describe Script do
+  let(:script) { Script.new }
+
+  it "checks script instance" do
+    assert script.instance_of?(Script)
+    assert script.respond_to?(:__rules)
+  end
+
+  it "has no watcher" do
+    script.load "n = 123"
+    assert_equal 0, script.__rules.size
+  end
+
+  it "has one watcher" do
+    script.load "n = 456; watch('.rb') { }"
+
+    assert_equal 1, script.__rules.size
+  end
+
+  it "calls a watcher" do
+    pattern = '\.rb'
+    value = 123
+    # script.load "n = value; watch(pattern) { n }" # WHAT??
+    script.load "n = #{value}; watch('#{pattern}') { n }"
+
+    rule = script.__rules.last
+    assert_equal [pattern, value], [rule.pattern, rule.proc.call]
+  end
+
+  it "receives a matchdata" do
+    script.load "watch('ab(.)') { |m| [m[0], m[1]] }"
+
+    rule = script.__rules.last
+    assert_equal ["abc", "c"], script.match_run(rule, "abc")
+  end
+
+  it "run" do
+    pattern = '.*\.rb'
+    script.load "watch('#{pattern}') { raise IOError }"
+
+    assert_raises(IOError) { script.run "a.rb" }
+  end
+
+  it "does not run" do
+    pattern = '.*\.rb'
+    script.load "watch('#{pattern}') { raise IOError }"
+
+    script.run "a.no" # no exception
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+if ENV["COVERAGE"]
+  require "simplecov"
+  SimpleCov.start do
+    add_filter "/test/"
+  end
+end
+
+require "minitest/autorun"
+require "ricecream"
+require "cuco"
+require "controller"
+require "script"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: cuco
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Dittmar Krall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: micro-optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple and flexible file watcher
+email: dittmar.krall@matiq.de
+executables:
+- cuco
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".watchr"
+- Gemfile
+- Gemfile.lock
+- LICENSE-MIT
+- README.md
+- Rakefile
+- bin/cuco
+- cuco.gemspec
+- lib/controller.rb
+- lib/cuco.rb
+- lib/script.rb
+- lib/version.rb
+- test/controller_test.rb
+- test/cuco_test.rb
+- test/script_test.rb
+- test/test_helper.rb
+homepage: http://www.matiq.de
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key: 
+specification_version: 4
+summary: A file watcher
+test_files: []