visionmedia-bind 0.1.0 → 0.2.0

data/History.rdoc

@@ -1,4 +1,16 @@
 
+=== 0.2.0 / 2009-03-09
+
+* Added gitignore
+* Added support for multiple actions
+* Added example for multiple actions
+* Added --eval to common options
+* Added spec runner / globbing example
+* Added #expand_dirs
+* Changed devel dependency visionmedia-commander >=2.5.6
+* Changed option :files to :paths
+* Removed RefreshBrowsersHaml, getting to specific to be helpful
+
 === 0.1.0 / 2009-03-03
 
 * Changed exec name bind to rbind to avoid collision

data/Manifest

@@ -1,14 +1,12 @@
 bin/rbind
 bind.gemspec
 examples/demo.html
+examples/globbing.rb
 examples/log_changes.rb
 examples/refresh_browsers.rb
-examples/refresh_browsers_haml.rb
 examples/style.css
-examples/style.sass
 History.rdoc
 lib/bind/actions/refresh_browsers.rb
-lib/bind/actions/refresh_browsers_haml.rb
 lib/bind/actions.rb
 lib/bind/command_helpers.rb
 lib/bind/listener.rb
@@ -18,10 +16,20 @@ Manifest
 Rakefile
 README.rdoc
 spec/bind_listener_spec.rb
+spec/fixtures/assets/bar.css
+spec/fixtures/assets/foo.css
+spec/fixtures/assets/jquery.js
+spec/fixtures/assets/js/app.js
+spec/fixtures/assets/js/test.js
 spec/fixtures/style.css
 spec/spec_helper.rb
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/release.rake
 tasks/spec.rake
+test/assets/javascripts/app/foo.js
+test/assets/javascripts/jquery.js
+test/assets/stylesheets/foo.css
+test/assets/stylesheets/style.css
+test/stylesheets/style.sass
 Todo.rdoc

data/README.rdoc

@@ -32,7 +32,7 @@ sass file is modified, it will be compiled to '..' (up a directory) preceding th
 
   path = 'http://localhost'
   action = Bind::Actions::RefreshBrowsersHaml.new path, '..', 'Safari', 'Firefox'
-  listener = Bind::Listener.new :interval => 1, :debug => $stdout, :action => action, :files => Dir['*.haml'] + Dir['*.sass']
+  listener = Bind::Listener.new :interval => 1, :debug => $stdout, :action => action, :paths => Dir['*.haml'] + Dir['*.sass']
   listener.run!
 
 == License:

data/Rakefile

@@ -4,13 +4,13 @@ require 'rake'
 require 'echoe'
 require './lib/bind.rb'
 
-Echoe.new("bind", Bind::VERSION::STRING) do |p|
+Echoe.new("bind", Bind::VERSION) do |p|
   p.author = "TJ Holowaychuk"
   p.email = "tj@vision-media.ca"
   p.summary = "bind actions to filesystem events"
   p.url = "http://github.com/visionmedia/bind"
   p.runtime_dependencies = []
-  p.runtime_dependencies << 'visionmedia-commander >=2.4.6'
+  p.runtime_dependencies << 'visionmedia-commander >=2.5.6'
 end
 
 Dir['tasks/**/*.rake'].sort.each { |lib| load lib }

data/Todo.rdoc

@@ -1,11 +1,11 @@
 
 == Major:
 
-* Add sass / haml support in exec
+* Test refresh eval
+* Better specs
 
 == Minor:
 
-* Support action / event pairs, n to n, not 1 to 1
 * Add more actions / events like atime
 
 == Brainstorming:

data/bin/rbind

@@ -11,19 +11,16 @@ program :description, 'Bind actions to filesystem events'
 
 command :to do |c|
   set_common_options c
-  c.syntax = 'rbind to <file> [file ...] [options] '
-  c.summary = 'Bind to modification of a file'
-  c.description = 'Bind to modification of a file or all files within a directory.'
-  c.example 'Bind to a single file, logging its path when changed', "bind to style.css -e 'puts file'"
-  c.option '-e', '--eval STRING', String, 'Evaluate a string of Ruby in context of Bind, so the file local variable is available.'
+  c.syntax = 'rbind to <path> [path ...] [options] '
+  c.summary = 'Bind to a file system event'
+  c.description = 'Bind to modification of a file or files within a directory.'
+  c.example 'Bind to a single file, logging its path when changed', "rbind to style.css -e 'puts file.path'"
+  c.example 'Bind to a file, and a directory of files', "rbind to stylesheets style.css -e 'puts file.path'"
+  c.example 'Run specs when ruby files are modified', "rbind to lib/**/*.rb -e 'system \"rake spec\"'"
   c.when_called do |args, options|
-    populate_common_options options
-    if options.eval
-      options.action = lambda { |file| eval options.eval }
-    else
-      abort 'invalid option. --eval switch is required in order to perform any action on the bound file(s)'
-    end
-    options.files = args
+    abort 'invalid option. --eval switch is required in order to perform any action on the bound file(s)' unless options.eval
+    common_options options
+    options.paths = args
     listener(options).run!
   end
 end
@@ -32,17 +29,17 @@ command :refresh do |c|
   set_common_options c
   c.syntax = 'rbind refresh <uri> [options]'
   c.summary = 'Bind to <uri>, refreshing browsers.'
-  c.description = 'Bind to <uri>, refreshing browsers when the files you are watching change.'
+  c.description = 'Bind to <uri>, refreshing browsers when the paths you are watching change.'
   c.example = 'Bind a few css files for quick editing in multiple browsers', 'bind refresh http://localhost/page --files style.css,reset.css --browsers Safari,Firefox'
   c.example = 'Bind local static html (no scheme)', 'bind refresh examples/demo.html -f style.css -b Safari'
   c.option '-b', '--browsers BROWSERS', Array, 'List of browsers you wish to refresh. Defaults to Safari'
-  c.option '-f', '--files FILES', Array, 'List of files to bind to.'
+  c.option '-p', '--paths PATHS', Array, 'List of files, directories, or globs to bind to'
   c.when_called do |args, options|
-    populate_common_options options
-    path = expand_path args.shift
+    common_options options
+    uri = expand_path args.shift
     browsers = options.browsers || ['Safari']
-    options.action = Bind::Actions::RefreshBrowsers.new path, *browsers
-    abort 'invalid option. --files switch is required in order to bind' if options.files.nil?
+    options.actions << Bind::Actions::RefreshBrowsers.new(uri, *browsers)
+    abort 'invalid option. --paths switch is required in order to bind' if options.paths.nil?
     listener(options).run!
   end
 end

data/bind.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bind}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-03-03}
+  s.date = %q{2009-03-09}
   s.default_executable = %q{rbind}
   s.description = %q{bind actions to filesystem events}
   s.email = %q{tj@vision-media.ca}
   s.executables = ["rbind"]
-  s.extra_rdoc_files = ["bin/rbind", "bind.gemspec", "lib/bind/actions/refresh_browsers.rb", "lib/bind/actions/refresh_browsers_haml.rb", "lib/bind/actions.rb", "lib/bind/command_helpers.rb", "lib/bind/listener.rb", "lib/bind/version.rb", "lib/bind.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/release.rake", "tasks/spec.rake"]
-  s.files = ["bin/rbind", "bind.gemspec", "examples/demo.html", "examples/log_changes.rb", "examples/refresh_browsers.rb", "examples/refresh_browsers_haml.rb", "examples/style.css", "examples/style.sass", "History.rdoc", "lib/bind/actions/refresh_browsers.rb", "lib/bind/actions/refresh_browsers_haml.rb", "lib/bind/actions.rb", "lib/bind/command_helpers.rb", "lib/bind/listener.rb", "lib/bind/version.rb", "lib/bind.rb", "Manifest", "Rakefile", "README.rdoc", "spec/bind_listener_spec.rb", "spec/fixtures/style.css", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/release.rake", "tasks/spec.rake", "Todo.rdoc"]
+  s.extra_rdoc_files = ["bin/rbind", "bind.gemspec", "lib/bind/actions/refresh_browsers.rb", "lib/bind/actions.rb", "lib/bind/command_helpers.rb", "lib/bind/listener.rb", "lib/bind/version.rb", "lib/bind.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/release.rake", "tasks/spec.rake"]
+  s.files = ["bin/rbind", "bind.gemspec", "examples/demo.html", "examples/globbing.rb", "examples/log_changes.rb", "examples/refresh_browsers.rb", "examples/style.css", "History.rdoc", "lib/bind/actions/refresh_browsers.rb", "lib/bind/actions.rb", "lib/bind/command_helpers.rb", "lib/bind/listener.rb", "lib/bind/version.rb", "lib/bind.rb", "Manifest", "Rakefile", "README.rdoc", "spec/bind_listener_spec.rb", "spec/fixtures/assets/bar.css", "spec/fixtures/assets/foo.css", "spec/fixtures/assets/jquery.js", "spec/fixtures/assets/js/app.js", "spec/fixtures/assets/js/test.js", "spec/fixtures/style.css", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/release.rake", "tasks/spec.rake", "test/assets/javascripts/app/foo.js", "test/assets/javascripts/jquery.js", "test/assets/stylesheets/foo.css", "test/assets/stylesheets/style.css", "test/stylesheets/style.sass", "Todo.rdoc"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/bind}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bind", "--main", "README.rdoc"]
@@ -26,11 +26,11 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<visionmedia-commander>, [">= 2.4.6"])
+      s.add_runtime_dependency(%q<visionmedia-commander>, [">= 2.5.6"])
     else
-      s.add_dependency(%q<visionmedia-commander>, [">= 2.4.6"])
+      s.add_dependency(%q<visionmedia-commander>, [">= 2.5.6"])
     end
   else
-    s.add_dependency(%q<visionmedia-commander>, [">= 2.4.6"])
+    s.add_dependency(%q<visionmedia-commander>, [">= 2.5.6"])
   end
 end

data/examples/globbing.rb

@@ -0,0 +1,7 @@
+
+require File.dirname(__FILE__) + '/../lib/bind'
+
+paths = [File.dirname(__FILE__) + '/*.rb']
+action = lambda { |file| puts "modified #{file.path}" } 
+listener = Bind::Listener.new :event => :change, :paths => paths, :interval => 1, :actions => [action], :timeout => 10
+listener.run!

data/examples/log_changes.rb

@@ -1,9 +1,9 @@
 
 require File.dirname(__FILE__) + '/../lib/bind'
 
-# Execute this file to start the listener, then alter style.css a few times
+# Execute this file to start the listener, then alter any file in this directory
 
-style = File.dirname(__FILE__) + '/style.css'
+paths = [File.dirname(__FILE__)]
 action = lambda { |file| puts "modified #{file}" } 
-listener = Bind::Listener.new :event => :change, :files => [style], :interval => 1, :action => action, :timeout => 10, :debug => $stdout
+listener = Bind::Listener.new :event => :change, :paths => paths, :interval => 1, :actions => [action], :timeout => 10, :debug => $stdout
 listener.run!

data/examples/refresh_browsers.rb

@@ -3,8 +3,10 @@ require File.dirname(__FILE__) + '/../lib/bind'
 
 # Execute this file to start the listener, then alter style.css a few times
 
+actions = []
 html  = File.expand_path(File.dirname(__FILE__) + '/demo.html')
 style = File.dirname(__FILE__) + '/style.css'
-action = Bind::Actions::RefreshBrowsers.new html, 'Safari', 'Firefox'
-listener = Bind::Listener.new :event => :change, :files => [style], :interval => 1, :action => action, :timeout => 60, :debug => $stdout
+actions << lambda { |file| puts "modified #{file.path}" }
+actions << Bind::Actions::RefreshBrowsers.new(html, 'Safari')
+listener = Bind::Listener.new :event => :change, :paths => [style], :interval => 1, :actions => actions, :timeout => 60
 listener.run!

data/examples/style.css

@@ -1,2 +1,3 @@
 h1 {
-  color: red; }
+  color: blue;
+}

data/lib/bind/actions.rb

@@ -2,6 +2,5 @@
 module Bind
   module Actions
     autoload :RefreshBrowsers, 'bind/actions/refresh_browsers'
-    autoload :RefreshBrowsersHaml, 'bind/actions/refresh_browsers_haml'
   end
 end

data/lib/bind/command_helpers.rb

@@ -3,6 +3,7 @@ def set_common_options c
   c.option '-i', '--interval SECONDS', Integer, 'Interval in seconds in which to listen for an event.'
   c.option '-t', '--timeout SECONDS', Integer, 'Timeout after n seconds.'
   c.option '-r', '--require LIBS', Array, 'Require ruby libraries.'
+  c.option '-e', '--eval STRING', String, 'Evaluate a string of Ruby in context of Bind, so the file local variable is available.'
   c.option '-V', '--verbose', 'Log information to STDOUT.'
 end
 
@@ -10,7 +11,9 @@ def listener options
   Bind::Listener.new options_to_hash(options)
 end
 
-def populate_common_options options
+def common_options options
+  options.actions ||= []
+  options.actions << lambda { |file| eval options.eval } if options.eval
   options.require.each { |lib| require lib } if options.require
   options.debug = $stdout if options.verbose
 end

data/lib/bind/listener.rb

@@ -3,7 +3,7 @@
 module Bind
   class Listener
     
-   attr_accessor :files, :action, :timeout, :interval, :event
+   attr_accessor :paths, :actions, :timeout, :interval, :event
    attr_reader :run_time, :start_time, :finish_time
   
    #--
@@ -13,12 +13,12 @@ module Bind
    class Error < StandardError; end
   
    ##
-   # Event listener. Must specify the :files, and :action options.
+   # Event listener. Must specify the :paths, and :action options.
    #
    # === Options:
    #
-   #   :files           array of files and / or directories
-   #   :action          an object responding to #call, which is used as the callback for the event handler
+   #   :paths           array of file or directory paths
+   #   :actions         objects responding to #call, which is used as the callbacks for the event handler
    #   :timeout         time in seconds, after which the listener should stop. Defaults to 0, meaning infinity
    #   :event           event to bind to, may be one of (:change). Defaults to :change
    #   :debug           log verbose debugging information to this stream
@@ -27,22 +27,36 @@ module Bind
     
    def initialize options = {}
      @run_time, @mtimes = 0, {}
-     @files = options.fetch :files do
-      raise ArgumentError, 'specify one or more :files (or directories) to bind the listener to'
+     @paths = options.fetch :paths do
+      raise ArgumentError, 'specify one or more :paths (or directories) to bind the listener to'
      end
-     @action = options.fetch :action do
-       raise ArgumentError, 'pass a valid :action responding to #call'
+     @actions = options.fetch :actions do
+       raise ArgumentError, ':actions must be an array of objects responding to #call'
      end
      @log = options.fetch :debug, false
      @timeout = options.fetch :timeout, 0
      @interval = options.fetch :interval, 2
      @event = options.fetch :event, :change
    end
+
+   ##
+   # Expand directories into file paths.
+   
+   def expand_dirs paths
+     paths.inject [] do |files, path|
+       case
+       when File.directory?(path) ; files += Dir["#{path}/**/*.*"]
+       when File.file?(path)      ; files << path
+       else                         files += Dir[path]
+       end
+     end    
+   end
    
    ##
    # Start the listener.
    
    def run!
+     files = expand_dirs @paths
      start_time = Time.now
      log "binding to #{files.join(', ')}, watching #{event} every #{interval} second(s)." + 
          (timeout > 0 ? " Terminating in #{timeout} seconds" : '')
@@ -61,13 +75,21 @@ module Bind
    
    private
    
+   ##
+   # Invoke all current actions with a +file+.
+   
+   def call_actions_with file
+     p actions
+     actions.each { |action| action.call file } 
+   end
+   
    ##
    # Handle change event.
    
    def change file
      if changed? file
        log "changed #{file.path}"
-       action.call file
+       call_actions_with file
        @mtimes[file.path] = file.mtime
      end
    end

data/lib/bind/version.rb

@@ -1,7 +1,4 @@
 
 module Bind
-  module VERSION #:nodoc:
-    MAJOR, MINOR, TINY = 0, 1, 0
-    STRING = [MAJOR, MINOR, TINY].join '.'
-  end
+  VERSION = '0.2.0'
 end

data/spec/bind_listener_spec.rb

@@ -1,14 +1,36 @@
 
 describe Bind::Listener do
   
-  def listener &action
-    Bind::Listener.new :event => :change, :files => [File.dirname(__FILE__) + '/fixtures/style.css'], :interval => 1, :action => action, :timeout => 2
+  def listener *paths, &action
+    Bind::Listener.new :event => :change, :paths => paths, :interval => 1, :actions => [action], :timeout => 2
   end
   
-  it "should record total runtime" do
+  it "should expand directories" do
+    files = %w(
+      ./spec/fixtures/assets/bar.css
+      ./spec/fixtures/assets/foo.css
+      ./spec/fixtures/assets/jquery.js
+      ./spec/fixtures/assets/js/app.js
+      ./spec/fixtures/assets/js/test.js
+    )
+    l = listener {}
+    l.expand_dirs(fixture_path('assets')).should == files
+  end
+  
+  it "should expand directories using globbing" do
+    files = %w(
+      ./spec/fixtures/assets/jquery.js
+      ./spec/fixtures/assets/js/app.js
+      ./spec/fixtures/assets/js/test.js
+    )
     l = listener {}
+    l.expand_dirs(fixture_path('assets/**/*.js')).should == files
+  end
+
+  it "should record total runtime" do
+    l = listener(fixture_path('style.css')) {}
     l.run!
     l.run_time.to_i.should == 2
   end
-  
+    
 end

data/spec/spec_helper.rb

@@ -1,2 +1,6 @@
 
-require 'bind'
+require 'bind'
+
+def fixture_path path
+  File.join File.dirname(__FILE__), 'fixtures', path
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-bind
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-03 00:00:00 -08:00
+date: 2009-03-09 00:00:00 -07:00
 default_executable: rbind
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.4.6
+        version: 2.5.6
     version: 
 description: bind actions to filesystem events
 email: tj@vision-media.ca
@@ -32,7 +32,6 @@ extra_rdoc_files:
 - bin/rbind
 - bind.gemspec
 - lib/bind/actions/refresh_browsers.rb
-- lib/bind/actions/refresh_browsers_haml.rb
 - lib/bind/actions.rb
 - lib/bind/command_helpers.rb
 - lib/bind/listener.rb
@@ -47,14 +46,12 @@ files:
 - bin/rbind
 - bind.gemspec
 - examples/demo.html
+- examples/globbing.rb
 - examples/log_changes.rb
 - examples/refresh_browsers.rb
-- examples/refresh_browsers_haml.rb
 - examples/style.css
-- examples/style.sass
 - History.rdoc
 - lib/bind/actions/refresh_browsers.rb
-- lib/bind/actions/refresh_browsers_haml.rb
 - lib/bind/actions.rb
 - lib/bind/command_helpers.rb
 - lib/bind/listener.rb
@@ -64,12 +61,22 @@ files:
 - Rakefile
 - README.rdoc
 - spec/bind_listener_spec.rb
+- spec/fixtures/assets/bar.css
+- spec/fixtures/assets/foo.css
+- spec/fixtures/assets/jquery.js
+- spec/fixtures/assets/js/app.js
+- spec/fixtures/assets/js/test.js
 - spec/fixtures/style.css
 - spec/spec_helper.rb
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/release.rake
 - tasks/spec.rake
+- test/assets/javascripts/app/foo.js
+- test/assets/javascripts/jquery.js
+- test/assets/stylesheets/foo.css
+- test/assets/stylesheets/style.css
+- test/stylesheets/style.sass
 - Todo.rdoc
 has_rdoc: true
 homepage: http://github.com/visionmedia/bind

data/examples/refresh_browsers_haml.rb

@@ -1,10 +0,0 @@
-
-require File.dirname(__FILE__) + '/../lib/bind'
-
-# Execute this file to start the listener, then alter style.css a few times
-
-html  = File.expand_path(File.dirname(__FILE__) + '/demo.html')
-style = File.dirname(__FILE__) + '/style.sass'
-action = Bind::Actions::RefreshBrowsersHaml.new html, '.', 'Safari'
-listener = Bind::Listener.new :event => :change, :files => [style], :interval => 2, :action => action, :debug => $stdout
-listener.run!

data/examples/style.sass

@@ -1,2 +0,0 @@
-h1
-  :color red

data/lib/bind/actions/refresh_browsers_haml.rb

@@ -1,40 +0,0 @@
-
-require 'rubygems'
-require 'haml'
-require 'haml/exec'
-
-module Bind
-  module Actions
-    class RefreshBrowsersHaml
-      
-      attr_accessor :browsers, :uri
-      
-      def initialize uri, dest, *browsers
-        @uri, @dest, @browsers = uri, File.expand_path(dest), browsers
-      end
-      
-      def call file
-        build_haml file if haml? file
-        build_sass file if sass? file
-        @browsers.each { |browser| `open -g -a #{browser} #{uri}` } 
-      end
-      
-      def build_haml file
-        `haml #{ file.path } #{ File.join(@dest, file.path.sub('.haml', '.html')) }`
-      end
-      
-      def build_sass file
-        `sass #{ file.path } #{ File.join(@dest, file.path.sub('.sass', '.css')) }`
-      end
-      
-      def haml? file
-        file.path.include? '.haml'
-      end
-      
-      def sass? file
-        file.path.include? '.sass'
-      end
-      
-    end
-  end
-end