zwerg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cc6b79e2842c2d7fd73d23c994432be87e4a97f3a1e23c3596fe4658a1f0a6b
+  data.tar.gz: c3f81dcdba96f0255be18f863c28f2cbfe08eecee52d06b7917308b682f6e031
+SHA512:
+  metadata.gz: bad591c47d47f91a80feb8c0fb3284165d62790dd2ac1e6c0577db42f7dfecd07a92e366897a8d7a4d1734bb984e644ec22fb6838c37107f5b0ecc406afdcc82
+  data.tar.gz: a4be1ecd56849f66b15cc99911258e498a450714cdfa310e3be33b7ddb8a51dfcd6804ae92191937e95f8a8ca0247421e42d8a71574b8578578a9e6bac734b5d

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Yuji Yaginuma
+
+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,112 @@
+# Zwerg
+
+Zwerg is a Ruby gem that watches for file changes and executes configurable actions based on YAML configuration files. It uses the [watchcat](https://github.com/y-yagi/watchcat) gem for efficient file system monitoring.
+
+## Features
+
+- Monitor files and directories for changes
+- Support for recursive directory watching
+- File pattern matching (glob patterns)
+- Configurable actions triggered by file changes
+- Variable substitution in action commands
+- Command execution triggered by file changes, file operations, logging, file operations, logging
+- Cross-platform support (Linux, macOS, Windows)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zwerg'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install zwerg
+```
+
+## Usage
+
+1. Create a configuration file (default: `zwerg.yml`):
+
+```yaml
+watches:
+  - path: "./src"
+    recursive: true
+    patterns:
+      - "*.rb"
+      - "*.yml"
+    actions:
+      - command: "echo 'Ruby file changed: {{file_name}}'"
+      - command: "rubocop {{file_path}}"
+```
+
+2. Run Zwerg:
+
+```bash
+zwerg                    # Uses zwerg.yml
+zwerg my_config.yml     # Uses custom config file
+```
+
+## Configuration
+
+### Watch Configuration
+
+Each watch entry can have the following properties:
+
+- `path`: The file or directory to watch (required)
+- `recursive`: Whether to watch subdirectories (default: true)
+- `patterns`: Array of glob patterns to match files (optional, matches all if empty)
+- `actions`: Array of actions to execute when files change (required)
+
+### Action Configuration
+
+Each action is simply a shell command:
+```yaml
+- command: "echo 'File changed: {{file_path}}'"
+```
+
+You can use any shell command, including complex operations with pipes, redirection, and conditional logic:
+```yaml
+- command: "if [ -f {{file_path}} ]; then echo 'File exists: {{file_name}}' >> changes.log; fi"
+```
+
+### Variable Substitution
+
+The following variables can be used in action configurations:
+
+- `{{file_path}}`: Full path to the changed file
+- `{{file_dir}}`: Directory containing the file
+- `{{file_name}}`: Name of the file (including extension)
+- `{{file_base}}`: Name of the file without extension
+- `{{file_ext}}`: File extension (including the dot)
+- `{{event_type}}`: Type of event (create, modify, remove, access)
+
+## Example Configuration
+
+See `example_zwerg.yml` for a comprehensive example configuration file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/zwerg. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/y-yagi/zwerg/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Zwerg project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/y-yagi/zwerg/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/example_zwerg.yml

@@ -0,0 +1,52 @@
+# Zwerg Configuration File
+# This file defines which directories to watch and what actions to take when files change
+
+watches:
+  # Watch a source directory for Ruby files
+  - path: "./src"
+    recursive: true
+    patterns:
+      - "*.rb"
+      - "*.yml"
+    actions:
+      - command: "echo 'Ruby/YAML file changed: {{file_name}}' >> ./logs/changes.log"
+      - command: "rubocop {{file_path}}"
+
+  # Watch a documentation directory
+  - path: "./docs"
+    recursive: true
+    patterns:
+      - "*.md"
+      - "*.txt"
+    actions:
+      - command: "echo 'Documentation updated: {{file_path}}'"
+      - command: "cp {{file_path}} ./backup/docs/"
+
+  # Watch configuration files in the root directory
+  - path: "."
+    recursive: false
+    patterns:
+      - "*.yml"
+      - "*.yaml"
+      - "*.json"
+    actions:
+      - command: "echo '[{{event_type}}] Config file changed: {{file_name}}'"
+      - command: "echo 'Config changed: {{file_path}}' | mail -s 'Config Alert' admin@example.com"
+
+  # Watch for log files and compress them when they get large
+  - path: "./logs"
+    recursive: false
+    patterns:
+      - "*.log"
+    actions:
+      - command: "if [ $(stat -c%s {{file_path}}) -gt 1048576 ]; then gzip {{file_path}}; fi"
+
+# Each action is a shell command that will be executed when files change
+
+# Available variables for substitution:
+# - {{file_path}}: Full path to the changed file
+# - {{file_dir}}: Directory containing the file
+# - {{file_name}}: Name of the file (including extension)
+# - {{file_base}}: Name of the file without extension
+# - {{file_ext}}: File extension (including the dot)
+# - {{event_type}}: Type of event (create, modify, remove, access)

data/exe/zwerg

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require "zwerg"
+
+def show_help
+  puts <<~HELP
+    Zwerg - A configurable file watcher that executes commands based on YAML configuration
+
+    USAGE:
+        zwerg [CONFIG_FILE] [OPTIONS]
+
+    ARGUMENTS:
+        CONFIG_FILE    Path to YAML configuration file (default: zwerg.yml)
+
+    OPTIONS:
+        -h, --help     Show this help message
+
+    EXAMPLES:
+        zwerg                    # Use default zwerg.yml config
+        zwerg my_config.yml      # Use custom config file
+        zwerg --help             # Show this help
+
+    CONFIGURATION:
+        Create a YAML file with the following structure:
+
+        watches:
+          - path: "./src"
+            recursive: true
+            patterns:
+              - "*.rb"
+              - "*.yml"
+            actions:
+              - command: "echo 'File changed: {{file_name}}'"
+              - command: "rubocop {{file_path}}"
+
+    AVAILABLE VARIABLES:
+        {{file_path}}   Full path to the changed file
+        {{file_dir}}    Directory containing the file
+        {{file_name}}   Name of the file (including extension)
+        {{file_base}}   Name of the file without extension
+        {{file_ext}}    File extension (including the dot)
+        {{event_type}}  Type of event (create, modify, remove, access)
+
+    For more information, visit: https://github.com/y-yagi/zwerg
+  HELP
+end
+
+# Check for help flag
+if ARGV.include?("-h") || ARGV.include?("--help")
+  show_help
+  exit 0
+end
+
+config_file = ARGV.find { |arg| !arg.start_with?("-") } || "zwerg.yml"
+
+begin
+  Zwerg.start(config_file)
+rescue Zwerg::Error => e
+  puts "Error: #{e.message}"
+  exit 1
+rescue Interrupt
+  puts "\nGoodbye!"
+  exit 0
+end

data/lib/zwerg/action_executor.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Zwerg
+  class ActionExecutor
+    def initialize(file_path, event)
+      @file_path = file_path
+      @event = event
+      @file_dir = File.dirname(file_path)
+      @file_name = File.basename(file_path)
+      @file_ext = File.extname(file_path)
+      @file_base = File.basename(file_path, @file_ext)
+    end
+
+    def execute(action)
+      execute_command(action)
+    rescue => e
+      puts "Error executing action #{action}: #{e.message}"
+    end
+
+    private
+
+    def execute_command(action)
+      command = substitute_variables(action["command"])
+      puts "Executing: #{command}"
+
+      success = system(command)
+      unless success
+        puts "Command failed with exit code: #{$?.exitstatus}"
+      end
+    end
+
+    def substitute_variables(template)
+      return template unless template.is_a?(String)
+
+      template
+        .gsub("{{file_path}}", @file_path)
+        .gsub("{{file_dir}}", @file_dir)
+        .gsub("{{file_name}}", @file_name)
+        .gsub("{{file_base}}", @file_base)
+        .gsub("{{file_ext}}", @file_ext)
+        .gsub("{{event_type}}", determine_event_type)
+    end
+
+    def determine_event_type
+      return "create" if @event.kind.create?
+      return "modify" if @event.kind.modify?
+      return "remove" if @event.kind.remove?
+      return "access" if @event.kind.access?
+      "unknown"
+    end
+  end
+end

data/lib/zwerg/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "psych"
+
+module Zwerg
+  class Config
+    attr_reader :watches
+
+    def initialize(data)
+      @watches = parse_watches(data["watches"] || [])
+    end
+
+    def self.load(file_path)
+      unless File.exist?(file_path)
+        raise Error, "Configuration file not found: #{file_path}"
+      end
+
+      begin
+        data = Psych.load_file(file_path)
+        new(data)
+      rescue Psych::SyntaxError => e
+        raise Error, "Invalid YAML syntax in #{file_path}: #{e.message}"
+      end
+    end
+
+    private
+
+    def parse_watches(watches_data)
+      watches_data.map do |watch_config|
+        {
+          path: watch_config["path"],
+          recursive: watch_config.fetch("recursive", true),
+          patterns: watch_config["patterns"] || [],
+          actions: watch_config["actions"] || []
+        }
+      end
+    end
+  end
+end

data/lib/zwerg/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Zwerg
+  VERSION = "0.1.0"
+end

data/lib/zwerg/watcher.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "watchcat"
+
+module Zwerg
+  class Watcher
+    def initialize(config)
+      @config = config
+      @watchers = []
+    end
+
+    def start
+      puts "Starting Zwerg file watcher..."
+
+      @config.watches.each do |watch_config|
+        start_watching_path(watch_config)
+      end
+
+      puts "Zwerg is now watching for file changes. Press Ctrl+C to stop."
+
+      # Keep the main thread alive
+      begin
+        sleep
+      rescue Interrupt
+        puts "\nStopping Zwerg..."
+        stop
+      end
+    end
+
+    def stop
+      @watchers.each(&:stop)
+      @watchers.clear
+    end
+
+    private
+
+    def start_watching_path(watch_config)
+      path = watch_config[:path]
+
+      unless File.exist?(path)
+        puts "Warning: Path does not exist: #{path}"
+        return
+      end
+
+      puts "Watching: #{path} (recursive: #{watch_config[:recursive]})"
+
+      watcher = Watchcat.watch(
+        path,
+        recursive: watch_config[:recursive],
+        wait_until_startup: true
+      ) do |event|
+        handle_file_event(event, watch_config)
+      end
+
+      @watchers << watcher
+    end
+
+    def handle_file_event(event, watch_config)
+      event.paths.each do |file_path|
+        next unless should_process_file?(file_path, watch_config[:patterns])
+
+        puts "File changed: #{file_path}"
+        execute_actions(file_path, event, watch_config[:actions])
+      end
+    end
+
+    def should_process_file?(file_path, patterns)
+      return true if patterns.empty?
+
+      patterns.any? do |pattern|
+        File.fnmatch?(pattern, File.basename(file_path)) ||
+          File.fnmatch?(pattern, file_path)
+      end
+    end
+
+    def execute_actions(file_path, event, actions)
+      executor = ActionExecutor.new(file_path, event)
+
+      actions.each do |action|
+        executor.execute(action)
+      end
+    end
+  end
+end

data/lib/zwerg.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "zwerg/version"
+require_relative "zwerg/watcher"
+require_relative "zwerg/config"
+require_relative "zwerg/action_executor"
+
+module Zwerg
+  class Error < StandardError; end
+
+  class << self
+    def start(config_file)
+      config_file ||= "zwerg.yml"
+      config = Config.load(config_file)
+      watcher = Watcher.new(config)
+      watcher.start
+    rescue => e
+      raise Error, "Failed to start Zwerg: #{e.message}"
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: zwerg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Yaginuma
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watchcat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+email:
+- yuuji.yaginuma@gmail.com
+executables:
+- zwerg
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- example_zwerg.yml
+- exe/zwerg
+- lib/zwerg.rb
+- lib/zwerg/action_executor.rb
+- lib/zwerg/config.rb
+- lib/zwerg/version.rb
+- lib/zwerg/watcher.rb
+homepage: https://github.com/y-yagi/zwerg
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/y-yagi/zwerg
+  source_code_uri: https://github.com/y-yagi/zwerg
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A configurable file watcher that executes commands based on YAML configuration.
+test_files: []