cuco 0.0.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df5d2e1075b623db0450271a4535f241da3946afc2b76091653a0a5b434d3a97
-  data.tar.gz: 58c75efde02ac4b5b2637d6cc80b2e6a76589b477d7c162a84e7e6fe11aa8df8
+  metadata.gz: 5342bb409b3bd1e9febe557662bf308acc1ae727911401b4be2a0d0d8fb06c07
+  data.tar.gz: 4948f0decd177693378761e046875a2808d4af80cfd0b17d5166aedfa4fb326c
 SHA512:
-  metadata.gz: 83a0f2b95909e51d131b8dcdf6c67cffbc7ccd9405da61bb75c0599a4f77eeef0b31425a81bc930d215524f93ddf32666b8cedcf750b6f867d388f6a95ba5308
-  data.tar.gz: 26245ecc48a0d9e4f7c19890e683944c4f2c99fb4a12840cb6e440688069583c3c74c61726bf7ac1de490715bb4e6cdd7e748f95d57e4bb5835128bc1c7c65e4
+  metadata.gz: 6d0c34c445d0ac41e63589a8e240f2bf3b6fcdc3414b6f060009004b14bd720428a2c331637c8df9554ba73d824e76f25f54a52a9f245ca2f844abcf7a67e71e
+  data.tar.gz: 9a9a183c7ee4aff77eb749797792cb7b686d490453ab92c72b6a3f03ecc2c331c723c69e4fd74f1f6f3bac40e556267d848eaf57a6c1761d4b7352c94c5aa8bc

data/.github/workflows/rake.yml

@@ -10,7 +10,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         ruby: ["3.0", 3.3]
-        test_command: ["bundle exec rake test"]
+        test_command: ["bundle exec rake"]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -19,6 +19,13 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
-          bundler-cache: true
-      - name: Build and test with Rake
-        run: bundle exec rake
+#          bundler-cache: true
+#      - name: Build and test with Rake
+#        run: bundle exec rake
+      - name: Bundle install
+        run: |
+          bundle config path /home/runner/bundle
+          bundle install
+          bundle update
+      - name: test with Rake
+        run: ${{ matrix.test_command }}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cuco (0.0.7)
+    cuco (0.1.1)
       listen
       micro-optparse
 
@@ -85,7 +85,7 @@ GEM
     psych (5.1.2)
       stringio
     racc (1.7.3)
-    rack (3.0.9.1)
+    rack (3.0.10)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -113,7 +113,7 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rdoc (6.6.2)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
     regexp_parser (2.9.0)
     reline (0.4.3)

data/README.md

@@ -1,6 +1,10 @@
 # Cuco
 
-*Cuco* watch files in a directory and take an action when they change.
+[![Gem Version](https://badge.fury.io/rb/cuco.png)](http://badge.fury.io/rb/cuco)
+[![GEM Downloads](https://img.shields.io/gem/dt/cuco?color=168AFE&logo=ruby&logoColor=FE1616)](https://rubygems.org/gems/cuco)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)
+
+*Cuco* watches 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
@@ -35,7 +39,10 @@ $ 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):
+## A simple example of a script file
+
+This sample script is intended for testing purposes with Minitest.
+*md* is the match-data (see Ruby regular expressions).
 
 ```ruby
 watch( 'test/.*_test\.rb$' ) { |md| run_it(md[0]) }
@@ -56,7 +63,6 @@ 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.

data/bin/cuco

@@ -4,6 +4,7 @@ lib = File.expand_path("../lib/", __dir__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 
 require "version"
+require "cuco"
 require "controller"
 require "micro-optparse"
 
@@ -13,6 +14,7 @@ options = Parser.new do |p|
   p.option :debug, "Debugging output", default: false
 end.process!
 
-cuco = Controller.instance
-cuco.init(options, ARGV)
-cuco.run
+G.init(options, ARGV)
+
+G.script = Script.new File.read(G.scriptname)
+Controller.instance.run

data/cuco.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |s|
     .split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "micro-optparse"
-  s.add_dependency "listen"
+  s.add_runtime_dependency "micro-optparse"
+  s.add_runtime_dependency "listen"
 
   s.add_development_dependency "minitest"
   s.add_development_dependency "rake"

data/lib/controller.rb

@@ -7,46 +7,60 @@ 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)
+    puts "*** Controller.run" if debug
     @listener = Listen.to(".") do |modified, added, removed|
       run_files(modified, :modified)
       run_files(added, :added)
     end
 
     @listener.start
+    puts "*** Listen started" if debug
     sleep
   end
 
   def stop
+    puts "*** Controller.stop" if debug
     @listener&.stop
-    @script = nil
+    G.script = nil
     @listener = nil
   end
 
+  def run_files(files, type)
+    puts "*** Controller.run_files(#{files}, #{type})" if debug
+    if files.include?(G.scriptname)
+      G.script = Script.new File.read(G.scriptname)
+      return
+    end
+
+    files.map! { |filename| filename[G.pwd_length + 1..] }
+    files.each { |filename| file_run(filename, type) }
+  end
+
+  def file_run(pattern, type = nil)
+    puts "*** file_run(#{pattern}, #{type})" if debug
+    rules = find_rules(pattern, type)
+    rules.each { |rule| match_run(rule, pattern) }
+  end
+
   private
 
-  def run_files(files, type)
-    files.map! { |filename| filename[@pwd_size + 1..] }
-    files.each { |filename| @script.run(filename, type) }
+  def find_rules(pattern, type)
+    puts "*** find_rules(#{pattern}, #{type})" if debug
+    G.script.__rules.reverse.select { |rule|
+      pattern.match(rule.pattern) &&
+        (rule.event_type.nil? || rule.event_type == type)
+    }
+  end
+
+  def match_run(rule, pattern)
+    md = pattern.match(rule.pattern)
+    puts "*** match_run #{rule}" if debug
+    rule.proc.call(md) if md
+  end
+
+  def debug
+    G.options[:debug]
   end
 end

data/lib/cuco.rb

@@ -1 +1,29 @@
 Rule = Struct.new(:pattern, :event_type, :proc)
+
+class G
+  class << self
+    attr_accessor :options
+    attr_accessor :pwd
+    attr_accessor :pwd_length
+    attr_accessor :script
+    attr_accessor :scriptname
+
+    def init(options, argv)
+      @options = options
+      @scriptname = File.expand_path(argv.first || ".watchr")
+      @pwd = Dir.pwd
+      @pwd_length = @pwd.length
+
+      puts "*** Cuco starts at #{Time.now}" if @options[:debug]
+      print if @options[:debug]
+    end
+
+    def print
+      puts "*** options #{@options}"
+      puts "*** pwd     <#{@pwd}>"
+      puts "*** pwd_length <#{@pwd_length}>"
+      puts "*** scriptname <#{@scriptname}>"
+      puts "*** script  <#{@script}>"
+    end
+  end
+end

data/lib/script.rb

@@ -1,38 +1,14 @@
 class Script
   attr_reader :__rules
 
-  def initialize
-    reset
-  end
-
-  def load(str)
-    reset
+  def initialize(str)
+    @__rules = []
     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"

data/lib/version.rb

@@ -1,5 +1,8 @@
 module Cuco
-  VERSION = "0.0.7" # 2024-03-18
+  VERSION = "0.1.1" # 2024-03-23
+  # VERSION = "0.1.0" # 2024-03-18
+  # VERSION = "0.0.8" # 2024-03-18
+  # 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

data/test/controller2_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+
+class R
+  class << self
+    attr_accessor :acc
+  end
+end
+
+describe Controller do
+  let(:cntrl) { Controller.instance }
+
+  def setup
+    R.acc = ""
+    G.init({}, [])
+    G.script = Script.new <<~EOS
+      watch('file')            { R.acc << "n" }
+      watch('file', :added)    { R.acc << "a" }
+      watch('file', :modified) { R.acc << "m" }
+    EOS
+  end
+
+  def teardown
+    cntrl.stop
+  end
+
+  it "fails with unknown what pattern" do
+    cntrl.file_run("fail", nil)
+    assert_equal "", R.acc
+  end
+
+  it "considers event_type nil" do
+    check nil, "n"
+  end
+
+  it "considers event_type :added" do
+    check :added, "an"
+  end
+
+  it "considers event_type :modified" do
+    check :modified, "mn"
+  end
+
+  it "receives a matchdata" do
+    G.script = Script.new "watch('ab(.)') { |m|
+      R.acc << m[0]
+      R.acc << m[1]
+    }"
+
+    cntrl.file_run("abc", nil)
+    assert_equal "abcc", R.acc
+  end
+
+  private
+
+  def check(type, expected)
+    cntrl.file_run("file", type)
+    assert_equal expected, R.acc
+  end
+end

data/test/controller_test.rb

@@ -1,52 +1,45 @@
 require "test_helper"
-require "timeout"
-require "controller"
-require "script"
 
 describe Controller do
-  let(:options) { {} }
-  let(:cuco) { Controller.instance }
-  let(:script) { Script.new }
+  let(:cntrl) { Controller.instance }
+  let(:regexp) { '.*\.rb' }
 
-  def teardown
-    cuco.stop
+  def setup
+    G.init({}, [])
   end
 
-  it "stops" do
-    cuco.stop
-    assert_nil cuco.listener
+  def teardown
+    cntrl.stop
   end
 
-  it "initializes" do
-    cuco.init(options, [])
+  it "stops" do
+    cntrl.stop
+    assert_nil cntrl.listener
   end
 
   it "runs" do
-    cuco.init(options, [])
     assert_raises(Timeout::Error) do
-      Timeout.timeout(0.1) { cuco.run }
+      Timeout.timeout(0.1) { cntrl.run }
     end
 
-    assert cuco.listener
+    assert cntrl.listener
   end
 
   it "read .watchr" do
-    filename = ".watchr"
-
-    script.load_file filename
-    assert_equal 2, script.__rules.size
+    assert_raises(Timeout::Error) do
+      Timeout.timeout(0.1) { cntrl.run }
+    end
   end
 
-  private
+  it "run" do
+    G.script = Script.new "watch('#{regexp}') { raise IOError }"
 
-  def test_files
-    dir = File.join(Dir.pwd, "test", "files")
-    files = find_files_in(dir)
-    files.collect { |file| File.join(dir, file) }
+    assert_raises(IOError) { cntrl.file_run "a.rb" }
   end
 
-  def find_files_in(dir)
-    entries = Dir.entries(dir)
-    entries.reject { |entry| File.directory?(entry) }
+  it "does not run" do
+    G.script = Script.new "watch('#{regexp}') { raise IOError }"
+
+    cntrl.file_run "a.no"
   end
 end

data/test/coverage_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+
+describe "Coverage" do
+  let(:cntrl) { Controller.instance }
+
+  def setup
+    G.init({}, [])
+  end
+
+  it "coverage run files" do
+    names = []
+    cntrl.run_files(names, nil)
+  end
+
+  it "coverage run files script" do
+    names = [G.scriptname]
+    cntrl.run_files(names, nil)
+  end
+end

data/test/cuco_test.rb

@@ -1,7 +1,9 @@
 require "test_helper"
 
 describe Cuco do
-  let(:cuco) { Controller.instance }
+  def setup
+    G.init({}, [])
+  end
 
   it "usage" do
     out, _err = capture_io do
@@ -11,21 +13,22 @@ describe Cuco do
     assert_match(/Usage/, out)
   end
 
+  it "coverage G.print " do
+    out, err = capture_io do
+      G.print
+    end
+
+    assert out
+    assert_equal "", err
+    assert_match(/scriptname/, out)
+    assert_match(/.watchr/, out)
+    assert_match(/pwd/, out)
+  end
+
   it "options" do
     options = {opt: 1234}
-    cuco.init(options, [])
+    G.init options, []
 
-    assert_equal options, cuco.options
+    assert_equal options, G.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

@@ -1,21 +1,19 @@
 require "test_helper"
-require "script"
 
 describe Script do
-  let(:script) { Script.new }
-
-  it "checks script instance" do
+  it "checks script" do
+    script = Script.new ""
     assert script.instance_of?(Script)
-    assert script.respond_to?(:__rules)
+    assert_equal %i[watch __rules].sort, script.public_methods(false).sort
   end
 
   it "has no watcher" do
-    script.load "n = 123"
+    script = Script.new "n = 123"
     assert_equal 0, script.__rules.size
   end
 
   it "has one watcher" do
-    script.load "n = 456; watch('.rb') { }"
+    script = Script.new "n = 456; watch('.rb') { }"
 
     assert_equal 1, script.__rules.size
   end
@@ -23,31 +21,9 @@ describe Script do
   it "calls a watcher" do
     pattern = '\.rb'
     value = 123
-    # script.load "n = value; watch(pattern) { n }" # WHAT??
-    script.load "n = #{value}; watch('#{pattern}') { n }"
+    script = Script.new "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

@@ -1,5 +1,6 @@
 if ENV["COVERAGE"]
   require "simplecov"
+
   SimpleCov.start do
     add_filter "/test/"
   end
@@ -7,6 +8,8 @@ end
 
 require "minitest/autorun"
 require "ricecream"
-require "cuco"
+
 require "controller"
+require "cuco"
 require "script"
+require "timeout"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuco
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.1
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-18 00:00:00.000000000 Z
+date: 2024-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: micro-optparse
@@ -88,7 +88,9 @@ files:
 - lib/cuco.rb
 - lib/script.rb
 - lib/version.rb
+- test/controller2_test.rb
 - test/controller_test.rb
+- test/coverage_test.rb
 - test/cuco_test.rb
 - test/script_test.rb
 - test/test_helper.rb