listen 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Master
+
+## 0.1.0 - January 28, 2012
+
+- First version with only a polling adapter and basic features set. ([@thibaudgg][])
+
+[@thibaudgg]: https://github.com/thibaudgg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 The listen team
+
+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,63 @@
+# Listen [![Build Status](https://secure.travis-ci.org/guard/listen.png?branch=master)](http://travis-ci.org/guard/listen)
+
+Work in progress...
+
+The Listen gem listens to file modifications and notifies you about the changes.
+
+Here the API that should be implemented, feel free to give your feeback via [Listen issues](https://github.com/guard/listener/issues)
+
+## Block API
+
+### One dir
+
+``` ruby
+Listen.to(dir, filter: '**/*', ignore: paths) do |modified, added, removed|
+  ...
+end
+```
+
+### Multiple dir
+
+``` ruby
+Listen.to do
+  path(dir1, filter: '**/*', ignore: paths) do |modified, added, removed|
+    ...
+  end
+  path(dir2, filter: '**/*', ignore: paths) do |modified, added, removed|
+    ...
+  end
+  ....
+end
+```
+
+Question: if dir2 is a child of dir1 both path block will be call if a file inside dir2 is modified right?
+
+## "Object" API
+
+``` ruby
+listen = Listen.to(dir)
+listen.ignore('.git')
+listen.filter('*.rb')
+listen.modification(&on_modification)
+listen.addition(&on_addition)
+listen.removal(&on_removal)
+listen.start # enter the run loop
+listen.stop
+```
+
+### Chainable
+
+``` ruby
+Listen.to(dir).ignore('.git').filter('*.rb').modification(&on_modification).addition(&on_addition).removal(&on_removal).start # enter the run loop
+```
+
+### Multiple dir support available via Thread.
+
+``` ruby
+listen  = Listen.ignore('.git')
+styles  = listen.to(dir1).filter('*.css').addition(&on_style_addition)
+scripts = listen.to(dir2).filter('*.js').addition(&on_script_addition)
+
+Thread.new { styles.start } # enter the run loop
+Thread.new { scripts.start } # enter the run loop
+```

data/lib/listen.rb

@@ -0,0 +1,24 @@
+require 'listen/listener'
+
+module Listen
+
+  # Listen to file system modifications.
+  #
+  # @param [String, Pathname] dir the directory to watch
+  # @param [Hash] options the listen options
+  # @option options [String] ignore a list of paths to ignore
+  # @option options [Regexp] filter a list of regexps file filters
+  #
+  # @yield [modified, added, removed] the changed files
+  # @yieldparam [Array<String>] modified the list of modified files
+  # @yieldparam [Array<String>] added the list of added files
+  # @yieldparam [Array<String>] removed the list of removed files
+  #
+  # @return [Listen::Listener] the file listener if no block given
+  #
+  def self.to(*args, &block)
+    listener = Listener.new(*args, &block)
+    block ? listener.start : listener
+  end
+
+end

data/lib/listen/adapter.rb

@@ -0,0 +1,18 @@
+module Listen
+  class Adapter
+
+    # Select the appropriate adapter implementation for the
+    # current OS and initializes it.
+    #
+    # @return [Listen::Adapter] the chosen adapter
+    #
+    def self.select_and_initialize(listener)
+      Adapters::Polling.new(listener)
+    end
+
+    def initialize(listener)
+      @listener = listener
+    end
+
+  end
+end

data/lib/listen/adapters/polling.rb

@@ -0,0 +1,48 @@
+module Listen
+  module Adapters
+
+    # Polling Adapter that works cross-platform and
+    # has no dependencies. This is the adapter that
+    # uses the most CPU processing power and has higher
+    # file IO that the other implementations.
+    #
+    class Polling < Adapter
+      attr_accessor :latency
+      
+      # Initialize the Adapter.
+      #
+      def initialize(*)
+        super
+        @latency = 1.0
+      end
+
+      # Start the adapter.
+      #
+      def start
+        @stop = false
+        poll
+      end
+
+      # Stop the adapter.
+      #
+      def stop
+        @stop = true
+      end
+
+      private
+
+      # Poll listener directory for file system changes.
+      #
+      def poll
+        until @stop
+          start = Time.now.to_f
+          @listener.on_change(@listener.directory)
+          nap_time = @latency - (Time.now.to_f - start)
+          sleep(nap_time) if nap_time > 0
+        end
+      end
+
+    end
+
+  end
+end

data/lib/listen/listener.rb

@@ -0,0 +1,203 @@
+require 'find'
+require 'listen/adapter'
+require 'listen/adapters/polling'
+
+module Listen
+  class Listener
+    attr_accessor :directory, :ignored_paths, :file_filters, :paths
+
+    # Default paths that gets ignored by the listener
+    DEFAULT_IGNORED_PATHS = %w[.bundle .git log tmp vendor]
+
+    # Initialize the file listener.
+    #
+    # @param [String, Pathname] dir the directory to watch
+    # @param [Hash] options the listen options
+    # @option options [String] ignore a list of paths to ignore
+    # @option options [Regexp] filter a list of regexps file filters
+    #
+    # @yield [modified, added, removed] the changed files
+    # @yieldparam [Array<String>] modified the list of modified files
+    # @yieldparam [Array<String>] added the list of added files
+    # @yieldparam [Array<String>] removed the list of removed files
+    #
+    # @return [Listen::Listener] the file listener
+    #
+    def initialize(*args, &block)
+      @directory     = args.first
+      @ignored_paths = DEFAULT_IGNORED_PATHS
+      @file_filters  = []
+      @block         = block
+      if args[1]
+        @ignored_paths += Array(args[1][:ignore]) if args[1][:ignore]
+        @file_filters  += Array(args[1][:filter]) if args[1][:filter]
+      end
+      @adapter = Adapter.select_and_initialize(self)
+    end
+
+    # Initialize the @paths and start the adapter.
+    #
+    def start
+      init_paths
+      @adapter.start
+    end
+
+    # Stop the adapter.
+    #
+    def stop
+      @adapter.stop
+    end
+
+    # Add ignored path to the listener.
+    #
+    # @example Ignore some paths
+    #   ignore ".git", ".svn"
+    #
+    # @param [Array<String>] paths a list of paths to ignore
+    #
+    # @return [Listen::Listener] the listener itself
+    #
+    def ignore(*paths)
+      @ignored_paths.push(*paths)
+      self
+    end
+
+    # Add file filters to the listener.
+    #
+    # @example Filter some files
+    #   ignore /\.txt$/, /.*\.zip/
+    #
+    # @param [Array<Regexp>] regexps a list of regexps file filters
+    #
+    # @return [Listen::Listener] the listener itself
+    #
+    def filter(*regexps)
+      @file_filters.push(*regexps)
+      self
+    end
+
+    # Set change callback block to the listener.
+    #
+    # @example Filter some files
+    #   callback = lambda { |modified, added, removed| ... }
+    #   change &callback
+    #
+    # @param [Block] block a block callback called on changes
+    #
+    # @return [Listen::Listener] the listener itself
+    #
+    def change(&block) # modified, added, removed
+      @block = block
+      self
+    end
+
+    # Call @block callback when there is a diff in the passed directory.
+    #
+    # @param [String] directory the directory to diff
+    #
+    def on_change(directory)
+      changes = diff(directory)
+      unless changes == { :modified => [], :added => [], :removed => [] }
+        @block.call(changes[:modified],changes[:added],changes[:removed])
+      end
+    end
+
+    # Initialize the @paths double levels Hash with all existing paths.
+    #
+    def init_paths
+      @paths = Hash.new { |h,k| h[k] = {} }
+      all_existing_paths { |path| insert_path(path) }
+    end
+
+    # Detect changes diff in a directory.
+    #
+    # @param [String] directory the path to diff
+    # @return [Hash<Array>] the file changes
+    #
+    def diff(directory = @directory)
+      @changes = { :modified => [], :added => [], :removed => [] }
+      detect_modifications_and_removals(directory)
+      detect_additions(directory)
+      @changes
+    end
+
+  private
+
+    # Research all existing paths (directories & files) filtered and without ignored directories paths.
+    #
+    # @yield [path] the existing path
+    #
+    def all_existing_paths
+      Find.find(@directory) do |path|
+        if File.directory?(path)
+          if @ignored_paths.any? { |ignored_path| path =~ /#{ignored_path}$/ }
+            Find.prune # Don't look any further into this directory.
+          else
+            yield(path)
+          end
+        elsif @file_filters.empty? || @file_filters.any? { |file_filter| path =~ file_filter }
+          yield(path)
+        end
+      end
+    end
+
+    # Insert a path with its File.stat in @paths.
+    #
+    # @param [String] path the path to insert in @paths.
+    #
+    def insert_path(path)
+      @paths[File.dirname(path)][File.basename(path)] = File.stat(path)
+    end
+
+    # Detect modifications and removals recursivly in a directory.
+    #
+    # @param [String] directory the path to analyze
+    #
+    def detect_modifications_and_removals(directory)
+      @paths[directory].each do |basename, stat|
+        path = File.join(directory, basename)
+
+        if stat.directory?
+          detect_modifications_and_removals(path)
+          @paths[directory].delete(basename) unless File.directory?(path)
+        else
+          if File.exist?(path)
+            new_stat = File.stat(path)
+            if stat.mtime != new_stat.mtime
+              @changes[:modified] << relative_path(path)
+              @paths[directory][basename] = new_stat
+            end
+          else
+            @paths[directory].delete(basename)
+            @changes[:removed] << relative_path(path)
+          end
+        end
+      end
+    end
+
+    # Detect additions in a directory.
+    #
+    # @param [String] directory the path to analyze
+    #
+    def detect_additions(directory)
+      all_existing_paths do |path|
+        next if @paths[File.dirname(path)][File.basename(path)]
+
+        @changes[:added] << relative_path(path) if File.file?(path)
+        insert_path(path)
+      end
+    end
+
+    # Convert absolute path to a path relative to the listener directory (by default).
+    #
+    # @param [String] path the path to convert
+    # @param [String] directory the directoy path to relative from
+    # @return [String] the relative converted path
+    #
+    def relative_path(path, directory = @directory)
+      base_dir = directory.sub(/\/$/, '')
+      path.sub(%r(^#{base_dir}/), '')
+    end
+
+  end
+end

data/lib/listen/version.rb

@@ -0,0 +1,3 @@
+module Listen
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: listen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Travis Tilley
+- Yehuda Katz
+- Thibaud Guillaume-Gentil
+- Rémy Coutable
+- Michael Kessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70178027214260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178027214260
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70178027229800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70178027229800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70178027228980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70178027228980
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70178027228220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70178027228220
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70178027227420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178027227420
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70178027226740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178027226740
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70178027226280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178027226280
+description: The Listen gem listens to file modifications and notifies you about the
+  changes.
+email:
+- ttilley@gmail.com
+- wycats@gmail.com
+- thibaud@thibaud.me
+- rymai@rymai.me
+- michi@netzpiraten.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/listen/adapter.rb
+- lib/listen/adapters/polling.rb
+- lib/listen/listener.rb
+- lib/listen/version.rb
+- lib/listen.rb
+- CHANGELOG.md
+- LICENSE
+- README.md
+homepage: https://github.com/guard/listen
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4340389000594607932
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: listen
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Listen to file modifications
+test_files: []
+has_rdoc: