filewatcher-cli 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a7885738bc63e99bd2be26af12b8ec536f29ec6e117e191dc507b973b152f3b
+  data.tar.gz: e46bb7b473ec6cc0943cb71aa3d0d63047d8ac989e866fcd5c2d47b2ab3b0ad5
+SHA512:
+  metadata.gz: 00c729fb158d7cc1f49bf09c53117e8b6f284b3c922ef741e1202725d494111a8ccaa9d3d36687c66f35d85e8a8fa422504e30346357d5c8bb697868e25dffbc
+  data.tar.gz: d02829a6821d3f7b7aeb537299199062fba11025a5e71b6755cc83db6eb41e9dd27e2c19a397ccb0d9843e73623c42e80e0956fdadb04a217d4e99160fc44afe

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## master (unreleased)
+
+## 1.0.0.beta1 (2020-09-19)
+
+*   Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Popov
+
+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,173 @@
+# Filewatcher CLI
+
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/filewatcher/filewatcher-cli?style=flat-square)](https://cirrus-ci.com/github/filewatcher/filewatcher-cli)
+[![Codecov branch](https://img.shields.io/codecov/c/github/filewatcher/filewatcher-cli/master.svg?style=flat-square)](https://codecov.io/gh/filewatcher/filewatcher-cli)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/filewatcher/filewatcher-cli.svg?style=flat-square)](https://codeclimate.com/github/filewatcher/filewatcher-cli)
+[![Depfu](https://img.shields.io/depfu/filewatcher/filewatcher-cli?style=flat-square)](https://depfu.com/repos/github/filewatcher/filewatcher-cli)
+[![Inline docs](https://inch-ci.org/github/filewatcher/filewatcher-cli.svg?branch=master)](https://inch-ci.org/github/filewatcher/filewatcher-cli)
+[![License](https://img.shields.io/github/license/filewatcher/filewatcher-cli.svg?style=flat-square)](LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/filewatcher-cli.svg?style=flat-square)](https://rubygems.org/gems/filewatcher-cli)
+
+CLI for [Filewatcher](https://github.com/filewatcher/filewatcher).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filewatcher-cli'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install filewatcher-cli
+```
+
+## Usage
+
+Run the `echo` command when the file `myfile` is changed:
+
+```sh
+$ filewatcher "myfile" "echo 'myfile has changed'"
+```
+
+Run any JavaScript in the current directory when it is updated in Windows
+PowerShell:
+
+```sh
+> filewatcher *.js "node %FILENAME%"
+```
+
+In Linux/macOS:
+
+```sh
+$ filewatcher *.js 'node $FILENAME'
+```
+
+Place filenames in quotes to use Ruby filename globbing instead
+of shell filename globbing. This will make Filewatcher look for files in
+subdirectories too. To watch all JavaScript files in subdirectories in Windows:
+
+```sh
+> filewatcher "**/*.js" "node %FILENAME%"
+```
+
+In Linux/macOS:
+
+```sh
+$ filewatcher '**/*.js' 'node $FILENAME'
+```
+
+By default, Filewatcher executes the command only for the first changed file
+that found from file system check, but you can using the `--every/-E` option
+for running the command on each changed file.
+
+```sh
+$ filewatcher -E * 'echo file: $FILENAME'
+```
+
+Try to run the updated file as a script when it is updated by using the
+`--exec/-e` option. Works with files with file extensions that looks like a
+Python, Ruby, Perl, PHP, JavaScript or AWK script.
+
+```sh
+$ filewatcher -e *.rb
+```
+
+Print a list of all files matching \*.css first and then output the filename
+when a file is being updated by using the `--list/-l` option:
+
+```sh
+$ filewatcher -l '**/*.css' 'echo file: $FILENAME'
+```
+
+Watch the "src" and "test" folders recursively, and run test when the file system gets updated:
+
+```sh
+$ filewatcher "src test" "ruby test/test_suite.rb"
+```
+
+### Restart long running commands
+
+The `--restart/-r` option kills the command if it's still running when
+a file system change happens. Can be used to restart locally running web servers
+on updates, or kill long running tests and restart on updates. This option
+often makes Filewatcher faster in general. To not wait for tests to finish:
+
+```sh
+$ filewatcher --restart "**/*.rb" "rake test"
+```
+
+By default, it sends `TERM` signal, but you can change it to what you want
+via `--restart-signal` option:
+
+```sh
+$ filewatcher --restart --restart-signal=KILL "**/*.rb" "rake test"
+```
+
+The `--immediate/-I` option starts the command on startup without waiting for file system updates. To start a web server and have it automatically restart when HTML files are updated:
+
+```sh
+$ filewatcher --restart --immediate "**/*.html" "python -m SimpleHTTPServer"
+```
+
+### Daemonizing Filewatcher process
+
+The `--daemon/-D` option starts Filewatcher in the background as system daemon, so Filewatcher will not be terminated by `Ctrl+C`, for example.
+
+### Available environment variables
+
+The environment variable `$FILENAME` is available in the shell command argument.
+On UNIX like systems the command has to be enclosed in single quotes. To run
+node whenever a JavaScript file is updated:
+
+```sh
+$ filewatcher *.js 'node $FILENAME'
+```
+
+Environment variables available from the command string:
+
+```
+BASENAME           File basename.
+FILENAME           Relative filename.
+ABSOLUTE_FILENAME  Absolute filename.
+RELATIVE_FILENAME  Same as FILENAME but starts with "./"
+EVENT              Event type. Is either 'updated', 'deleted' or 'created'.
+DIRNAME            Absolute directory name.
+```
+
+### Enable plugins
+
+When you use Filewatcher via CLI, you can enable plugins for it via `--plugins/-p` option:
+
+```sh
+# Require `spinner` plugin and then enable a spinner via new option from this plugin
+$ filewatcher -p spinner --spinner '**/*'
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `toys rspec` to run the tests.
+
+To install this gem onto your local machine, run `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/filewatcher/filewatcher-cli).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/exe/filewatcher

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/filewatcher/cli/command'
+
+Filewatcher::CLI::Command.run

data/lib/filewatcher/cli.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'filewatcher'
+
+require_relative 'cli/constants'

data/lib/filewatcher/cli/command.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'filewatcher'
+
+require_relative 'env'
+require_relative 'runner'
+require_relative 'constants'
+
+require 'clamp'
+
+class Filewatcher
+  module CLI
+    ## Class for CLI command
+    class Command < Clamp::Command
+      banner <<~TEXT
+        Filewatcher scans the file system and executes shell commands when files changes.
+      TEXT
+
+      require_relative 'command/options'
+
+      parameter 'FILES', 'file names to scan'
+
+      parameter '[COMMAND]', 'shell command to execute when file changes'
+
+      def execute
+        @child_pid = nil
+
+        initialize_filewatcher
+
+        print_if_list
+
+        Process.daemon(true, true) if daemon?
+
+        watch
+      rescue SystemExit, Interrupt
+        @filewatcher.finalize
+      end
+
+      private
+
+      def initialize_filewatcher
+        @filewatcher = Filewatcher.new(
+          files,
+          ## https://github.com/mdub/clamp/issues/105
+          self.class.declared_options.map do |option|
+            [option.attribute_name.to_sym, public_send(option.read_method)]
+          end.to_h
+        )
+      end
+
+      def split_files_void_escaped_whitespace(files)
+        files
+          .map { |name| name.gsub(/\\\s/, '_ESCAPED_WHITESPACE_').split(/\s/) }
+          .flatten
+          .uniq
+          .map { |name| name.gsub('_ESCAPED_WHITESPACE_', '\ ') }
+      end
+
+      def watch
+        @filewatcher.watch do |changes|
+          changes = every? ? changes : changes.first(1)
+
+          changes.each do |filename, event|
+            command = command_for_file filename
+
+            next puts "file #{event}: #{filename}" unless command
+
+            @child_pid = execute_command filename, event, command
+          end
+        end
+      end
+
+      def print_if_list
+        return unless list?
+
+        puts 'Watching:'
+        @filewatcher.found_filenames.each { |filename| puts " #{filename}" }
+      end
+
+      def execute_command(filename, event, command)
+        env = Filewatcher::CLI::Env.new(filename, event).to_h
+        if restart?
+          restart(@child_pid, restart_signal, env, command)
+        else
+          spawn env, command
+          nil
+        end
+      end
+
+      def command_for_file(filename)
+        if exec? && File.exist?(filename) then Filewatcher::CLI::Runner.new(filename).command
+        elsif command then command
+        end
+      end
+
+      def restart(pid, restart_signal, env, command)
+        begin
+          raise Errno::ESRCH unless pid
+
+          Process.kill(restart_signal, pid)
+          Process.wait(pid)
+        rescue Errno::ESRCH
+          nil # already killed
+        end
+        Process.spawn(env, command)
+      end
+
+      def spawn(env, command)
+        Process.spawn(env, command)
+        Process.wait
+      rescue SystemExit, Interrupt
+        exit(0)
+      end
+    end
+  end
+end

data/lib/filewatcher/cli/command/options.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class Filewatcher
+  module CLI
+    ## Options for CLI command
+    class Command < Clamp::Command
+      option %w[-I --immediate], :flag, 'immediately execute a command',
+        default: false
+
+      option %w[-E --every --each], :flag,
+        'run command for every updated file in one file system check',
+        default: false
+
+      option %w[-D --daemon --background], :flag, 'run in the background as system daemon',
+        default: false
+
+      option %w[-r --restart --fork], :flag, 'restart process when file system is updated',
+        default: false
+
+      option '--restart-signal', 'VALUE', 'termination signal for `restart` option',
+        default: 'TERM'
+
+      option %w[-l --list], :flag, 'print name of files being watched',
+        default: false
+
+      option %w[-e --exec --execute], :flag, 'execute file as a script when file is updated',
+        default: false
+
+      option '--include', 'GLOB', 'include files',
+        default: File.join('**', '*')
+
+      option '--exclude', 'GLOB', 'exclude file(s) matching', default: nil do |string|
+        split_files_void_escaped_whitespace string.split(' ') unless string.to_s.empty?
+      end
+
+      option %w[-i --interval], 'SECONDS', 'interval to scan file system', default: 0.5 do |string|
+        Float(string)
+      end
+
+      option %w[-p --plugins], 'LIST', 'list of comma-separated required plugins',
+        default: [] do |string|
+          string.split(',').each { |plugin| require "filewatcher/#{plugin}" }
+        end
+    end
+  end
+end

data/lib/filewatcher/cli/constants.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Filewatcher
+  module CLI
+    BINDIR = 'exe'
+
+    VERSION = '1.0.0.beta1'
+  end
+end

data/lib/filewatcher/cli/env.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Filewatcher
+  module CLI
+    # Class for building ENV variables for executable
+    class Env
+      def initialize(filename, event)
+        @filename = filename
+        @event = event
+        @path = Pathname.new(@filename)
+        @realpath = @path.exist? ? @path.realpath : @path
+        @current_dir = Pathname.new(Dir.pwd)
+        # For safely `immediate` option with empty-strings arguments
+        @relative_path =
+          (@realpath.to_s.empty? ? @current_dir : @realpath)
+            .relative_path_from(@current_dir)
+      end
+
+      def to_h
+        {
+          'FILEPATH' => (@realpath.to_s if @event != :deleted),
+          'FILENAME' => @filename,
+          'BASENAME' => @path.basename.to_s,
+          'EVENT' => @event.to_s,
+          'DIRNAME' => @path.parent.realpath.to_s,
+          'ABSOLUTE_FILENAME' => @realpath.to_s,
+          'RELATIVE_FILENAME' => @relative_path.to_s
+        }
+      end
+    end
+  end
+end

data/lib/filewatcher/cli/runner.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Filewatcher
+  module CLI
+    ## Get runner command by filename
+    class Runner
+      ## Define runners for `--exec` option
+      RUNNERS = {
+        python: %w[py],
+        node: %w[js],
+        ruby: %w[rb],
+        perl: %w[pl],
+        awk: %w[awk],
+        php: %w[php phtml php4 php3 php5 phps]
+      }.freeze
+
+      def initialize(filename)
+        @filename = filename
+        @ext = File.extname(filename).delete('.')
+      end
+
+      def command
+        "env #{runner} #{@filename}" if runner
+      end
+
+      private
+
+      def runner
+        return @runner if defined? @runner
+
+        @runner, _exts = RUNNERS.find { |_cmd, exts| exts.include? @ext }
+        @runner
+      end
+    end
+  end
+end

data/lib/filewatcher/cli/spec_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'filewatcher/spec_helper'
+
+class Filewatcher
+  module CLI
+    ## Helper for CLI specs
+    module SpecHelper
+      include Filewatcher::SpecHelper
+
+      def environment_specs_coefficients
+        super.merge(
+          ## https://cirrus-ci.com/build/6442339705028608
+          lambda do
+            RUBY_PLATFORM == 'java' && ENV['CI'] && is_a?(Filewatcher::Spec::ShellWatchRun)
+          end => 2
+        )
+      end
+
+      ## https://github.com/rubocop-hq/ruby-style-guide/issues/556#issuecomment-691274359
+      # rubocop:disable Style/ModuleFunction
+      extend self
+      # rubocop:enable Style/ModuleFunction
+    end
+  end
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: filewatcher-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: ruby
+authors:
+- Thomas Flemming
+- Alexander Popov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.43'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.43'
+description: 'CLI for Filewatcher.
+
+  '
+email:
+- thomas.flemming@gmail.com
+- alex.wayfer@gmail.com
+executables:
+- filewatcher
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/filewatcher
+- lib/filewatcher/cli.rb
+- lib/filewatcher/cli/command.rb
+- lib/filewatcher/cli/command/options.rb
+- lib/filewatcher/cli/constants.rb
+- lib/filewatcher/cli/env.rb
+- lib/filewatcher/cli/runner.rb
+- lib/filewatcher/cli/spec_helper.rb
+homepage: https://github.com/filewatcher/filewatcher-cli
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/filewatcher/filewatcher-cli
+  homepage_uri: https://github.com/filewatcher/filewatcher-cli
+  changelog_uri: https://github.com/filewatcher/filewatcher-cli/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: CLI for Filewatcher
+test_files: []