dirwatch 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28e52feff4b1a4dc37784ad8068a61045bba844f
+  data.tar.gz: 54355f3b6eb1102921ecd050103fff6efddb3331
+SHA512:
+  metadata.gz: a3f8a0c321dea9d1bf37ef79ca92cb8d23e3a2338a32ec571d08a9c762eb8c7b27b7426ca5314b08f1f70057bd96b3e24abb5741a8ccf4ddd66a673840de5083
+  data.tar.gz: 78150645c779c24cef4af453487f6dfb3458b0a569340eb1cc167a8e365e4b7828c7b24f10c83cadbaf7d0c93172b939a05328db3b2db6c6a41d4dd15bc2c3f9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nicolas
+
+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,2 @@
+# dirwatch
+A ruby gem to watch specific files and execute commands when any of the files change

data/bin/dirwatch

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+#require 'dirwatch'
+require_relative '../lib/dirwatch'
+watcher = Dirwatch::Watcher.from_args ARGV
+watcher.start
+
+begin
+  sleep
+rescue Interrupt
+ensure
+  puts "shutting down..."
+  watcher.stop
+end

data/lib/dirwatch/options.rb

@@ -0,0 +1,54 @@
+module Dirwatch
+  class Options
+    def self.from_args args
+      require 'optparse'
+      require 'ostruct'
+
+      show_help = false
+      options = OpenStruct.new
+      options.directory = './'
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0} [options] [directory]"
+
+        opts.on('-f', '--file-match MATCH', 'The bash match for the file. Default: *.tex') do |match|
+          options.file_match = match
+        end
+
+        opts.on('-i', '--interval INTERVAL', OptionParser::DecimalNumeric, 'The number of seconds to wait unitl the next check. Default: 1') do |interval|
+          options.interval = interval
+        end
+
+        opts.on('-d', '--daemonize', 'Run the programm as a daemon') do
+          options.daemonize = true
+        end
+
+        opts.on('-h', '--help', 'Show this help') do
+          puts opts
+          exit
+        end
+      end
+      parser.parse! args
+
+      unless args.empty?
+        if args.size > 1
+          puts 'Too many arguments'
+          puts parser
+          exit
+        end
+        options.directory = args.first
+      end
+
+      new options.to_h
+    end
+
+    attr_reader :directory, :file_match, :interval, :daemonize
+
+    def initialize directory: nil, file_match: nil, interval: nil, daemonize: nil
+      raise 'The directory is required' unless directory
+      @directory = directory
+      @file_match = file_match || '*.tex'
+      @interval = interval || 1
+      @daemonize = !!daemonize
+    end
+  end
+end

data/lib/dirwatch/settings/watch_setting.rb

@@ -0,0 +1,45 @@
+module Dirwatch
+  class Settings
+    class WatchSetting
+      attr_reader :interval, :scripts
+
+      def initialize directory:, file_match:, interval:, scripts:
+        @directory = directory
+        raise 'directory must be set' if @directory.nil? || @directory.empty?
+        @file_match = file_match
+        raise 'file_match must be set' if @file_match.nil? || @file_match.empty?
+        @interval = interval || raise('interval must be set')
+        raise 'the interval must be greater than 0' if @interval <= 0
+        if scripts.is_a? String
+          scripts = [scripts]
+        elsif !scripts.is_a?(Array) || scripts.any? {|s| !s.is_a? String }
+          raise "the scripts need to be either one string or a list of strings. Not: #{scripts.insepct}"
+        end
+        @scripts = scripts
+      end
+
+      def files_path
+        File.join @directory, '**', @file_match
+      end
+
+      def files
+        Dir[files_path]
+      end
+
+      def exec_scripts
+        @scripts.each do |script|
+          if script =~ / & *\z/
+            system script
+          else
+            output = %x(#{script})
+            raise "The command \"#{script}\" failed with: #{output}" if $? != 0
+          end
+        end
+      end
+
+      def to_s
+        "#<#{self.class} files_path=#{files_path} interval=#{interval.inspect} scripts=#{scripts.inspect}>"
+      end
+    end
+  end
+end

data/lib/dirwatch/settings.rb

@@ -0,0 +1,58 @@
+require_relative 'settings/watch_setting'
+
+module Dirwatch
+  class Settings
+    def self.from_options options
+      Settings.from_file(File.join(options.directory, 'dirwatch.yml'), options)
+    end
+
+    def self.from_file filename, options
+      settings = new
+      config = symbolize YAML.load_file(filename)
+      watch_data = {}
+      defaults = {}
+      config.each do |key, watch_setting|
+        if key == :defaults
+          defaults.merge! watch_setting
+        else
+          watch_data[key] = watch_setting
+        end
+      end
+      watch_data.each do |key, watch_setting|
+        settings << WatchSetting.new(
+          directory:  options.directory,
+          file_match: watch_setting[:file_match] || defaults[:file_match],
+          interval:   watch_setting[:interval]   || defaults[:interval],
+          scripts:    watch_setting[:script]     || defaults[:script],
+        )
+      end
+      settings
+    end
+
+    attr_reader :watch_settings
+
+    def initialize
+      @watch_settings = []
+    end
+
+    def << watch_setting
+      add watch_setting
+    end
+
+    def add watch_setting
+      @watch_settings << watch_setting
+    end
+
+    def by_interval &block
+      @watch_settings.group_by(&:interval).each(&block)
+    end
+
+    private
+
+    def self.symbolize(obj)
+      return obj.inject({}){|memo,(k,v)| memo[k.to_sym] =  symbolize(v); memo} if obj.is_a? Hash
+      return obj.inject([]){|memo,v    | memo           << symbolize(v); memo} if obj.is_a? Array
+      return obj
+    end
+  end
+end

data/lib/dirwatch/version.rb

@@ -0,0 +1,3 @@
+module Dirwatch
+  VERSION = '0.0.0'
+end

data/lib/dirwatch/watcher.rb

@@ -0,0 +1,56 @@
+module Dirwatch
+  class Watcher
+    def self.from_args args
+      new Options.from_args(args)
+    end
+
+    attr_reader :options
+
+    def initialize options
+      @options = options
+      @settings = Settings.from_options @options
+
+      if options.daemonize
+        Process.daemon true, true
+        puts "running in the background... [#{Process.pid}]"
+      end
+    end
+
+    def start
+      raise 'already started' if @threads
+      @threads = []
+      @stop = false
+
+      Thread.abort_on_exception = true
+      @settings.by_interval do |interval, watch_settings|
+        watch_settings.each {|ws| puts "Watching #{ws}" }
+        @threads << Thread.new do
+          change_times = []
+          loop do
+            break if @stop
+            watch_settings.each.with_index do |ws, i|
+              change_time = ws.files.map {|f| File.ctime f }.max
+              if change_time != change_times[i]
+                change_times[i] = change_time
+                ws.exec_scripts
+              end
+            end
+
+            break if @stop
+            sleep interval
+          end
+        end
+      end
+    end
+
+    def stop
+      raise 'not started' unless @threads
+      @stop = true
+      @threads.each {|t| t.join }
+    end
+
+    def files
+      Dir[File.join options.directory, '**', options.file_match]
+    end
+  end
+end

data/lib/dirwatch.rb

@@ -0,0 +1,7 @@
+require 'yaml'
+require_relative 'dirwatch/watcher'
+require_relative 'dirwatch/options'
+require_relative 'dirwatch/settings'
+
+module Dirwatch
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: dirwatch
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Nicolas Ganz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-19 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: nicolas@keltec.ch
+executables:
+- dirwatch
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/dirwatch
+- lib/dirwatch.rb
+- lib/dirwatch/options.rb
+- lib/dirwatch/settings.rb
+- lib/dirwatch/settings/watch_setting.rb
+- lib/dirwatch/version.rb
+- lib/dirwatch/watcher.rb
+homepage: https://github.com/ThunderKey/dirwatch
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Watch specific files and execute commands when any of them change
+test_files: []