visionmedia-bind 0.0.2

data/History.rdoc

@@ -0,0 +1,4 @@
+
+=== 0.0.1 / 2009-03-03
+
+* Initial release

data/Manifest

@@ -0,0 +1,23 @@
+bin/bind
+bind.gemspec
+examples/demo.html
+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/style.css
+spec/spec_helper.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake
+Todo.rdoc

data/README.rdoc

@@ -0,0 +1,36 @@
+
+= Bind
+
+Bind actions to various file system events, helping aid in
+automation of tasks such as refreshing browser(s) when you
+update a css / sass / js file.
+
+== Features
+
+* Coming soon
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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.
+GS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require './lib/bind.rb'
+
+Echoe.new("bind", Bind::VERSION::STRING) 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'
+end
+
+Dir['tasks/**/*.rake'].sort.each { |lib| load lib }

data/Todo.rdoc

@@ -0,0 +1,13 @@
+
+== Major:
+
+* Add support for an eval BEFORE actions, such as building SASS / HAML
+
+== Minor:
+
+* Support action / event pairs, n to n, not 1 to 1
+* Add more actions / events like atime
+
+== Brainstorming:
+
+* Nothing

data/bin/bind

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bind'
+require 'bind/command_helpers'
+require 'commander'
+
+program :name, 'Bind'
+program :version, Bind::VERSION::STRING
+program :description, 'Bind actions to filesystem events'
+
+command :to do |c|
+  set_common_options c
+  c.syntax = 'bind 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 change 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.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
+    listener(options).run!
+  end
+end
+
+command :refresh do |c|
+  set_common_options c
+  c.syntax = 'bind 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.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.when_called do |args, options|
+    populate_common_options options
+    path = 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?
+    listener(options).run!
+  end
+end

data/bind.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bind}
+  s.version = "0.0.2"
+
+  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.default_executable = %q{bind}
+  s.description = %q{bind actions to filesystem events}
+  s.email = %q{tj@vision-media.ca}
+  s.executables = ["bind"]
+  s.extra_rdoc_files = ["bin/bind", "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/spec.rake"]
+  s.files = ["bin/bind", "bind.gemspec", "examples/demo.html", "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/style.css", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "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"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{bind}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{bind actions to filesystem events}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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"])
+    else
+      s.add_dependency(%q<visionmedia-commander>, [">= 2.4.6"])
+    end
+  else
+    s.add_dependency(%q<visionmedia-commander>, [">= 2.4.6"])
+  end
+end

data/examples/demo.html

@@ -0,0 +1,8 @@
+<html>
+	<body>
+		<title>Bind Demo</title>
+		<link rel="stylesheet" href="style.css" />
+	</body>
+	<h1>Bind Demo</h1>
+	<p>Try binding to style.css and editing it, then watch bind update several browsers simaltaniously.</p>
+</html>

data/examples/log_changes.rb

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

data/examples/refresh_browsers.rb

@@ -0,0 +1,10 @@
+
+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.css'
+action = Bind::Actions::RefreshBrowsers.new html, 'Safari', 'Firefox'
+listener = Bind::Listener.new :event => :change, :files => [style], :interval => 1, :action => action, :timeout => 60, :log => $stdout
+listener.run!

data/examples/style.css

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

data/lib/bind.rb

@@ -0,0 +1,28 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# 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.
+#++
+
+$:.unshift File.dirname(__FILE__)
+
+require 'bind/version'
+require 'bind/listener'
+require 'bind/actions'

data/lib/bind/actions.rb

@@ -0,0 +1,6 @@
+
+module Bind
+  module Actions
+    autoload :RefreshBrowsers, 'bind/actions/refresh_browsers'
+  end
+end

data/lib/bind/actions/refresh_browsers.rb

@@ -0,0 +1,18 @@
+
+module Bind
+  module Actions
+    class RefreshBrowsers
+      
+      attr_accessor :browsers, :uri
+      
+      def initialize uri, *browsers
+        @uri, @browsers = uri, browsers
+      end
+      
+      def call file
+        @browsers.each { |browser| `open -g -a #{browser} #{uri}` } 
+      end
+      
+    end
+  end
+end

data/lib/bind/command_helpers.rb

@@ -0,0 +1,27 @@
+
+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 '-V', '--verbose', 'Log information to STDOUT.'
+end
+
+def listener options
+  Bind::Listener.new options_to_hash(options)
+end
+
+def populate_common_options options
+  options.require.each { |lib| require lib } if options.require
+  options.debug = $stdout if options.verbose
+end
+
+def expand_path path
+  path.include?('://') ? path : File.expand_path(path)
+end
+
+def options_to_hash options
+  options.singleton_methods.inject({}) do |hash, meth| 
+    hash[meth.to_sym] = options.send meth unless meth =~ /=$/
+    hash
+  end
+end

data/lib/bind/listener.rb

@@ -0,0 +1,93 @@
+
+
+module Bind
+  class Listener
+    
+   attr_accessor :files, :action, :timeout, :interval, :event
+   attr_reader :run_time, :start_time, :finish_time
+  
+   #--
+   # Exceptions
+   #++
+   
+   class Error < StandardError; end
+  
+   ##
+   # Event listener. Must specify the :files, 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
+   #   :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
+   #   :interval        sleep interval in seconds. Defaults to 2
+   #
+    
+   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'
+     end
+     @action = options.fetch :action do
+       raise ArgumentError, 'pass a valid :action 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
+   
+   ##
+   # Start the listener.
+   
+   def run!
+     start_time = Time.now
+     log "binding to #{files.join(', ')}, watching #{event} every #{interval} second(s)." + 
+         (timeout > 0 ? " Terminating in #{timeout} seconds" : '')
+     catch :halt do
+       loop do
+         @run_time = Time.now - start_time
+         throw :halt if timeout > 0 and @run_time >= timeout
+         log '.', true
+         files.each { |file| send event, File.new(file) } 
+         sleep interval
+       end
+     end
+     finish_time = Time.now
+     log "binding terminated"
+   end
+   
+   private
+   
+   ##
+   # Handle change event.
+   
+   def change file
+     if changed? file
+       log "changed #{file.path}"
+       action.call file
+       @mtimes[file.path] = file.mtime
+     end
+   end
+   
+   ##
+   # Check if +file+ has been modified since the last check.
+   
+   def changed? file
+     file.mtime > (@mtimes[file.path] ||= file.mtime)
+   end
+   
+   ##
+   # Optionally log a +message+ when a stream has been specified.
+   
+   def log message, print = false
+     if @log
+       print ? @log.print(message) : @log.puts(message)
+       @log.flush
+     end 
+   end
+   
+  end
+end

data/lib/bind/version.rb

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

data/spec/bind_listener_spec.rb

@@ -0,0 +1,14 @@
+
+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
+  end
+  
+  it "should record total runtime" do
+    l = listener {}
+    l.run!
+    l.run_time.to_i.should == 2
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+
+require 'bind'

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: visionmedia-bind
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-03 00:00:00 -08:00
+default_executable: bind
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: visionmedia-commander
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.4.6
+    version: 
+description: bind actions to filesystem events
+email: tj@vision-media.ca
+executables: 
+- bind
+extensions: []
+
+extra_rdoc_files: 
+- bin/bind
+- 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/spec.rake
+files: 
+- bin/bind
+- bind.gemspec
+- examples/demo.html
+- 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/style.css
+- spec/spec_helper.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- Todo.rdoc
+has_rdoc: true
+homepage: http://github.com/visionmedia/bind
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Bind
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: bind
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: bind actions to filesystem events
+test_files: []
+