file_monitor 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+vendor/**
+.bundle/**

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p180@file_daemon"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  [[ -s ".rvm/hooks/after_use" ]] && . ".rvm/hooks/after_use"
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id"
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory, you can uncomment the following code.
+#
+#   # Ensure that Bundler is installed. Install it if it is not.
+#   if ! command -v bundle >/dev/null; then
+#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#      gem install bundler
+#   fi
+#
+#   # Bundle while reducing excess noise.
+#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
+#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
+#
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    file_monitor (0.1.0)
+      daemons
+      fssm
+      rb-inotify
+      trollop
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    daemons (1.1.0)
+    diff-lcs (1.1.2)
+    ffi (1.0.7)
+      rake (>= 0.8.7)
+    flexmock (0.9.0)
+    fssm (0.2.5)
+    rake (0.8.7)
+    rb-inotify (0.8.4)
+      ffi (>= 0.5.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  file_monitor!
+  flexmock
+  rspec

data/README.md

@@ -0,0 +1,22 @@
+# FileMonitor
+
+### Usage
+    # Given a yaml configuration file like so:
+    #
+    # logfile:
+    #   path: /tmp/file_monitor.log
+    # monitor:
+    #   path: /tmp
+ 
+    # Run from shell
+    file_monitor --config-path /tmp/config.yml start
+ 
+    # You will now see create,updates, & deletes from /tmp printed to STDOUT
+
+
+
+#### TODO
+- daemon plugin so the file monitoring doesn't block the shell
+
+  
+

data/bin/file_monitor

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/file_monitor', __FILE__)
+FileMonitor::CommandLine.new ARGV

data/file_monitor.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'file_monitor/version'
+
+Gem::Specification.new do |s|
+  s.name        = "file_monitor"
+  s.version     = FileMonitor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["James Cook", "Ben Holley"]
+  s.email       = ["james@isotope11.com"]
+  s.summary     = %q{Wrapper around FSSM for ease of use"}
+  #s.description = %q{}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "file_monitor"
+
+  s.add_dependency "rb-inotify"
+  s.add_dependency "daemons"
+  s.add_dependency "fssm"
+  s.add_dependency "trollop"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "flexmock"
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables        = %w(file_monitor)
+  s.default_executable = "file_monitor"
+  s.require_paths      = ["lib"]
+end

data/lib/file_monitor.rb

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+
+# Standard libraries
+require 'logger'
+require 'yaml'
+
+# Gem libraries
+require 'fssm'
+
+lib = File.expand_path('../', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+module FileMonitor
+  autoload :Version,           'file_monitor/version'
+  autoload :Core,              'file_monitor/core'
+  autoload :CommandLine,       'file_monitor/command_line'
+  autoload :Configuration,     'file_monitor/configuration'
+  autoload :Logger,            'file_monitor/logger' # This should go away.. needs to be a hook
+  autoload :Worker,            'file_monitor/worker'
+  require 'file_monitor/hooks'
+end

data/lib/file_monitor/command_line.rb

@@ -0,0 +1,46 @@
+module FileMonitor
+  class CommandLine
+    def initialize argv=[]
+      require 'trollop'
+      parse self, argv if argv.any?
+    end
+
+    def file_monitor_banner
+<<-EOT
+Usage: file_monitor -c /path/to/config.yml COMMAND [ARGS]
+
+The file monitor commands are:
+ start          Starts the file monitor and watches a specified directory.
+ stop           Stops the file monitor
+ --version
+EOT
+    end
+
+    def available_commands
+      %w(start stop)
+    end
+
+    def parse _self, argv
+      global_opts = Trollop::options(argv) do
+        banner _self.file_monitor_banner
+        opt :config_path, "Configuration Path", :short => "-c", :type => :string
+        stop_on _self.available_commands
+      end
+
+      command  = argv.shift # get the subcommand
+      cmd_opts = case command
+        when "start"
+          Trollop::options(argv) do
+            opt :config_path, "Configuration Path", :short => "c"
+          end
+
+          watch_dir   = argv.unshift
+          config_path = global_opts[:config_path]
+          FileMonitor::Core.new(:config_path => config_path, :watch_dir => File.expand_path(File.join(watch_dir))).run
+        when "stop"
+        else
+          Trollop::die "unknown command #{command.inspect}"
+        end
+    end
+  end
+end

data/lib/file_monitor/configuration.rb

@@ -0,0 +1,12 @@
+module FileMonitor
+  class Configuration
+    attr_accessor :logfile_path, :watch_dir
+    attr_reader   :data
+    def initialize *args
+      options        = args.last.is_a?(Hash) ? args.pop : {}
+      config_path    = options[:config_path]
+      config_content = ::File.exist?(config_path.to_s) ? YAML.load_file(config_path) : {"logfile" => {}, "monitor" => {}}
+      @data           = config_content
+    end
+  end
+end

data/lib/file_monitor/core.rb

@@ -0,0 +1,43 @@
+module FileMonitor
+  class Core
+    attr_reader   :hooks
+    attr_accessor :config
+    def initialize *args
+      args.flatten!
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      @hooks  = []
+      @config = FileMonitor::Configuration.new(:config_path => options[:config_path], :watch_dir => options[:watch_dir])
+    end
+
+    def add_hook klass, call_method=:run
+      @hooks.push [klass, call_method]
+      self
+    end
+
+    def remove_hook klass
+      @hooks.delete_if{|k,m| k.to_s == klass.to_s }
+      self
+    end
+
+    def run
+      _self = self
+      FSSM.monitor(config.data["monitor"]["path"]) do
+        update{|base, relative| _self.hook!(:update, base, relative) }
+        delete{|base, relative| _self.hook!(:delete, base, relative) }
+        create{|base, relative| _self.hook!(:create, base, relative) }
+      end
+    end
+
+    def hook! event, *args
+      if hooks.empty?
+        hooks.push default_hook
+      end
+      hooks.map{|klass, call_method| FileMonitor::Hooks.const_get(klass).send(call_method, *[event, args]) }
+    end
+
+    private
+    def default_hook
+      ["StandardOutput", "run"]
+    end
+  end
+end

data/lib/file_monitor/hooks.rb

@@ -0,0 +1,9 @@
+lib = File.expand_path('../', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+module FileMonitor
+  module Hooks
+    autoload :StandardOutput, 'hooks/standard_output.rb'
+    autoload :FileLog,        'hooks/file_log.rb'
+  end
+end

data/lib/file_monitor/hooks/file_log.rb

@@ -0,0 +1,20 @@
+module FileMonitor
+  module Hooks
+    class FileLog
+      def self.run *args
+        io << args.inspect
+      end
+
+      def self.io
+        require "logger"
+        @io = ::Logger.new(log_path)
+      end
+
+      def self.log_path=(path)
+        @log_path = path
+      end
+
+      def self.log_path; @log_path; end
+    end
+  end
+end

data/lib/file_monitor/hooks/standard_output.rb

@@ -0,0 +1,19 @@
+module FileMonitor
+  module Hooks
+    class StandardOutput
+      # This is the default hook. Writes CREATE, UPDATE and DELETE events to STDOUT
+      def self.run *args
+        io.puts args.inspect
+      end
+
+      def self.io
+        @io = STDOUT if @io.nil?
+        @io
+      end
+
+      def self.io= _io
+        @io = _io # Set to a file, StringIO, etc. StringIO is used for specs.
+      end
+    end
+  end
+end

data/lib/file_monitor/version.rb

@@ -0,0 +1,3 @@
+module FileMonitor
+  VERSION = "0.1.0"
+end

data/spec/file_daemon_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe FileMonitor do
+  describe FileMonitor::Core do
+    before do
+      @monitor = FileMonitor::Core.new [{}]
+    end
+    context "#add_hook" do
+      it "should register a hook" do
+        @monitor.add_hook "Klass", :run
+        @monitor.hooks.last.should == ["Klass", :run]
+      end
+    end
+
+    context "#remove_hook" do
+      it "should unregister a hook" do
+        @monitor.add_hook "Klass", :run
+        @monitor.remove_hook "Klass"
+        @monitor.hooks.should be_empty
+      end
+    end
+
+    context "#hook!" do
+      before do
+        @io = StringIO.new
+        FileMonitor::Hooks::StandardOutput.io = @io
+      end
+
+      it "should fire the run method on registered hooks" do
+        @monitor.hook! [:update, "x", "y"]  # Simulate what FSSM passes in when a file gets modified or created
+        @io.rewind
+        @io.read.should == "[[:update, \"x\", \"y\"], []]\n"
+      end
+    end
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,4 @@
+logfile:
+  path: /tmp/file_monitor_log
+monitor:
+  path: /tmp

data/spec/lib/file_monitor/command_line_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe FileMonitor::CommandLine do
+  context "#parse" do
+    before :each do
+      flexmock( FileMonitor::Core).new_instances do |m|
+        m.should_receive(:run).once.and_return{ true }
+      end
+    end
+
+    after :each do
+      flexmock_verify
+    end
+
+    context "given a config path and a start/stop command" do
+      it "should call FileMonitor::Core" do
+        FileMonitor::CommandLine.new ["--config-path", "/tmp/config.yml", "start"]
+      end
+    end
+  end
+end

data/spec/lib/file_monitor/configuration_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+describe FileMonitor::Configuration do
+  context "#new" do
+    context "given a valid path" do
+      let(:config_path){ File.join(File.dirname(__FILE__),  "..", "..", "fixtures", "config.yml") }
+      it "should parse and have convenience methods for each settings" do
+        @config = FileMonitor::Configuration.new :config_path => config_path
+        @config.data.should be_an_instance_of(Hash)
+        @config.data["logfile"].should be_an_instance_of(Hash)
+        @config.data["monitor"].should be_an_instance_of(Hash)
+        @config.data["logfile"]["path"].should be_an_instance_of(String)
+        @config.data["monitor"]["path"].should be_an_instance_of(String)
+      end
+    end
+  end
+end

data/spec/lib/file_monitor/file_log_hook_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe FileMonitor do
+  describe FileMonitor::Hooks::FileLog do
+    before do
+      @monitor = FileMonitor::Core.new [{}]
+      @file = Tempfile.new "sample_file_monitor_hook"
+      FileMonitor::Hooks::FileLog.log_path = @file.path
+      @monitor.add_hook "FileLog", :run
+    end
+
+    context "#hook!" do
+
+      it "should fire the run method on registered hooks" do
+        @monitor.hook! [:update, "x", "y"]
+        @file.rewind
+        @file.read.should == "[[:update, \"x\", \"y\"], []]"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+lib = File.expand_path('../../', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require "lib/file_monitor.rb"
+
+RSpec.configure do |config|
+  config.mock_with :flexmock
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification 
+name: file_monitor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Cook
+- Ben Holley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-31 00:00:00 -05:00
+default_executable: file_monitor
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rb-inotify
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fssm
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: 
+email: 
+- james@isotope11.com
+executables: 
+- file_monitor
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/file_monitor
+- file_monitor.gemspec
+- lib/file_monitor.rb
+- lib/file_monitor/command_line.rb
+- lib/file_monitor/configuration.rb
+- lib/file_monitor/core.rb
+- lib/file_monitor/hooks.rb
+- lib/file_monitor/hooks/file_log.rb
+- lib/file_monitor/hooks/standard_output.rb
+- lib/file_monitor/version.rb
+- spec/file_daemon_spec.rb
+- spec/fixtures/config.yml
+- spec/lib/file_monitor/command_line_spec.rb
+- spec/lib/file_monitor/configuration_spec.rb
+- spec/lib/file_monitor/file_log_hook_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: file_monitor
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper around FSSM for ease of use"
+test_files: 
+- spec/file_daemon_spec.rb
+- spec/fixtures/config.yml
+- spec/lib/file_monitor/command_line_spec.rb
+- spec/lib/file_monitor/configuration_spec.rb
+- spec/lib/file_monitor/file_log_hook_spec.rb
+- spec/spec_helper.rb