livereload 1.2.2 → 1.3

data/bin/livereload

@@ -1,9 +1,51 @@
 #! /usr/bin/env ruby
 require 'rubygems'
 require 'livereload'
+require 'optparse'
 
-dir = File.expand_path('.')
-exts = "html,css,js,png,gif,jpg,php,py,rb,erb"
-host = "0.0.0.0"
-port = 10083
-LiveReload.run host, port, dir, exts
+def parse_command_line_config(args)
+  LiveReload::Config.new do |config|
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: livereload [options] [directory1 directory2 ...]"
+
+      opts.separator ""
+      opts.separator "Browser communication options:"
+
+      opts.on("--address [ADDRESS]", "Network interface to listen on (default is 0.0.0.0)") do |v|
+        config.host = v
+      end
+
+      opts.on("--port [PORT]", Integer, "TCP port to listen on (default is 10083)") do |v|
+        config.port = v.to_i
+      end
+
+      opts.separator ""
+      opts.separator "Debugging options:"
+
+      opts.on("-D", "--[no-]debug", "Print debugging info") do |v|
+        config.debug = v
+      end
+
+      opts.separator ""
+      opts.separator "Common options:"
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on_tail("--version", "Show version") do
+        puts LiveReload::GEM_VERSION
+        exit
+      end
+    end
+
+    opts.parse!(args)
+  end
+end
+
+explicit_config = parse_command_line_config(ARGV)
+
+directories = if ARGV.size == 0 then ['.'] else ARGV end
+LiveReload.run directories, explicit_config

data/lib/livereload.rb

@@ -1,40 +1,260 @@
 require 'em-websocket'
 require 'directory_watcher'
+require 'json/objects'
 
 # Chrome sometimes sends HTTP/1.0 requests in violation of WebSockets spec
+# hide the warning about redifinition of a constant
+saved_stderr = $stderr
+$stderr = StringIO.new
 EventMachine::WebSocket::HandlerFactory::PATH = /^(\w+) (\/[^\s]*) HTTP\/1\.[01]$/
+$stderr = saved_stderr
+
+class Object
+  def method_missing_with_livereload id, *args, &block
+    if id == :config
+      Object.send(:instance_variable_get, '@livereload_config')
+    else
+      method_missing_without_livereload id, *args, &block
+    end
+  end
+end
 
 module LiveReload
-  VERSION = "1.2"
-
-  def self.start_watching ws
-    $dw.add_observer { |*args|
-      args.each { |event|
-        if event[:type] == :modified
-          name = File.basename(event[:path]) 
-          puts "Modified: #{name}"
-          ws.send name
-        end
-      }
-    }
-    $dw.start
+  GEM_VERSION = "1.3"
+  API_VERSION = "1.3"
+
+  PROJECT_CONFIG_FILE_TEMPLATE = <<-END.strip.split("\n").collect { |line| line.strip + "\n" }.join("")
+  # Lines starting with pound sign (#) are ignored.
+
+  # additional extensions to monitor
+  #config.exts << 'haml'
+
+  # exclude files with NAMES matching this mask
+  #config.exclusions << '~*'
+  # exclude files with PATHS matching this mask (if the mask contains a slash)
+  #config.exclusions << '/excluded_dir/*'
+  # exclude files with PATHS matching this REGEXP
+  #config.exclusions << /somedir.*(ab){2,4}\.(css|js)$/
+
+  # reload the whole page when .js changes
+  #config.apply_js_live = false
+  # reload the whole page when .css changes
+  #config.apply_css_live = false
+  END
+
+  # note that host and port options do not make sense in per-project config files
+  class Config
+    attr_accessor :host, :port, :exts, :exclusions, :debug, :apply_js_live, :apply_css_live
+
+    def initialize &block
+      @host           = nil
+      @port           = nil
+      @debug          = nil
+      @exts           = []
+      @exclusions     = []
+      @apply_js_live  = nil
+      @apply_css_live = nil
+
+      update!(&block) if block
+    end
+
+    def update!
+      yield self
+
+      # remove leading dots
+      @exts = @exts.collect { |e| e.sub(/^\./, '') }
+    end
+
+    def merge! other
+      @host           = other.host             if other.host
+      @port           = other.port             if other.port
+      @exts          += other.exts
+      @exclusions     = other.exclusions + @exclusions
+      @debug          = other.debug            if other.debug != nil
+      @apply_js_live  = other.apply_js_live    if other.apply_js_live != nil
+      @apply_css_live = other.apply_css_live   if other.apply_css_live != nil
+
+      self
+    end
+
+    class << self
+      def load_from file
+        Config.new do |config|
+          if File.file? file
+            Object.send(:instance_variable_set, '@livereload_config', config)
+            Object.send(:alias_method, :method_missing_without_livereload, :method_missing)
+            Object.send(:alias_method, :method_missing, :method_missing_with_livereload)
+            load file, true
+            Object.send(:alias_method, :method_missing, :method_missing_without_livereload)
+            Object.send(:instance_variable_set, '@livereload_config', nil)
+          end
+        end
+      end
+
+      def merge *configs
+        configs.reduce(Config.new) { |merged, config| config && merged.merge!(config) || merged }
+      end
+    end
+  end
+
+  DEFAULT_CONFIG = Config.new do |config|
+    config.debug = false
+    config.host  = '0.0.0.0'
+    config.port  = 10083
+    config.exts  = %w/html css js png gif jpg php php5 py rb erb/
+    config.exclusions = %w!*/.git/* */.svn/* */.hg/*!
+    config.apply_js_live  = true
+    config.apply_css_live = true
+  end
+
+  USER_CONFIG_FILE = File.expand_path("~/.livereload")
+  USER_CONFIG = Config.load_from(USER_CONFIG_FILE)
+
+  class Project
+    attr_reader :config
+
+    def initialize directory, explicit_config=nil
+      @directory = directory
+      @explicit_config = explicit_config
+      read_config
+    end
+
+    def read_config
+      project_config_file = File.join(@directory, '.livereload')
+      unless File.file? project_config_file
+        File.open(project_config_file, 'w') do |file|
+          file.write PROJECT_CONFIG_FILE_TEMPLATE
+        end
+      end
+      project_config = Config.load_from project_config_file
+      @config = Config.merge(DEFAULT_CONFIG, USER_CONFIG, project_config, @explicit_config)
+    end
+
+    def print_config
+      puts "Watching: #{@directory}"
+      puts "  - extensions: " + @config.exts.collect {|e| ".#{e}"}.join(" ")
+      if !@config.apply_js_live && !@config.apply_css_live
+        puts "  - live refreshing disabled for .css & .js: will reload the whole page on every change"
+      elsif !@config.apply_js_live
+        puts "  - live refreshing disabled for .js: will reload the whole page when .js is changed"
+      elsif !@config.apply_css_live
+        puts "  - live refreshing disabled for .css: will reload the whole page when .css is changed"
+      end
+      if @config.exclusions.size > 0
+        puts "  - excluding changes in: " + @config.exclusions.join(" ")
+      end
+    end
+    
+    def is_excluded? path
+      basename = File.basename(path)
+      @config.exclusions.any? do |exclusion|
+        if Regexp === exclusion
+          path =~ exclusion
+        elsif exclusion.include? '/'
+          File.fnmatch?(File.join(@directory, exclusion), path)
+        else
+          File.fnmatch?(exclusion, basename)
+        end
+      end
+    end
+
+    def when_changes_detected &block
+      @when_changes_detected = block
+    end
+
+    def restart_watching
+      if @dw
+        @dw.stop
+      end
+      @dw = DirectoryWatcher.new @directory, :glob => "{.livereload,**/*.{#{@config.exts.join(',')}}}", :scanner => :em, :pre_load => true
+      @dw.add_observer do |*args|
+        begin
+          args.each do |event|
+            path = event[:path]
+            if File.basename(path) == '.livereload'
+              @when_changes_detected.call [:config_changed, path]
+            elsif event[:type] == :modified
+              @when_changes_detected.call [if is_excluded?(path) then :excluded else :modified end, path]
+            end
+          end
+        rescue
+          puts $!
+          puts $!.backtrace
+        end
+      end
+      @dw.start
+    end
+  end
+
+  def self.configure
+    yield Config
   end
 
-  def self.run(host, port, dir, exts)
+  def self.run(directories, explicit_config)
+    # EventMachine needs to run kqueue for the watching API to work
     EM.kqueue = true if EM.kqueue?
-    # Could someone with more knowledge of glob specify that the ".git" directory should not be searched
-    $dw = DirectoryWatcher.new dir, :glob => "**/*.{#{exts}}", :scanner => :em
+
+    web_sockets = []
+
+    # for host and port
+    global_config = Config.merge(DEFAULT_CONFIG, USER_CONFIG, explicit_config)
+    directories = directories.collect { |directory| File.expand_path(directory) }
+    projects = directories.collect { |directory| Project.new(directory, explicit_config) }
 
     puts
-    puts "Version:    #{VERSION}"
-    puts "Port:       #{port}"
-    puts "Directory:  #{dir}"
-    puts "Extensions: " + exts.split(",").collect {|e| ".#{e}"}.join(" ")
-    puts "LiveReload is waiting for browser to connect."
-    EventMachine::WebSocket.start(:host => host, :port => port, :debug => false) do |ws|
-      ws.onopen    { puts "Browser connected."; ws.send "!!ver:#{VERSION}"; start_watching ws }
-      ws.onmessage { |msg| puts "Browser URL: #{msg}" }
-      ws.onclose   { puts "Browser disconnected." }
+    puts "Version:  #{GEM_VERSION}  (compatible with browser extension versions #{API_VERSION}.x)"
+    puts "Port:     #{global_config.port}"
+    projects.each { |project| project.print_config }
+
+    EventMachine.run do
+      projects.each do |project|
+        project.when_changes_detected do |event, modified_file|
+          case event
+          when :config_changed
+            puts
+            puts ">> Configuration change: " + modified_file
+            puts
+            EventMachine.next_tick do
+              projects.each { |project| project.read_config; project.print_config }
+              puts
+              projects.each { |project| project.restart_watching }
+            end
+          when :excluded
+            puts "Excluded: #{File.basename(modified_file)}"
+          when :modified
+            puts "Modified: #{File.basename(modified_file)}"
+            data = ['refresh', { :path => modified_file,
+                :apply_js_live  => project.config.apply_js_live,
+                :apply_css_live => project.config.apply_css_live }].to_json
+            puts data if global_config.debug
+            web_sockets.each do |ws|
+              ws.send data
+            end
+          end
+        end
+      end
+
+      projects.each { |project| project.restart_watching }
+
+      puts
+      puts "LiveReload is waiting for browser to connect."
+      EventMachine::WebSocket.start(:host => global_config.host, :port => global_config.port, :debug => global_config.debug) do |ws|
+        ws.onopen do
+          begin
+            puts "Browser connected."; ws.send "!!ver:#{API_VERSION}"; web_sockets << ws
+          rescue
+            puts $!
+            puts $!.backtrace
+          end
+        end
+        ws.onmessage do |msg|
+          puts "Browser URL: #{msg}"
+        end
+        ws.onclose do
+          web_sockets.delete ws
+          puts "Browser disconnected."
+        end
+      end
     end
   end
 end

metadata

@@ -4,9 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 2
-  - 2
-  version: 1.2.2
+  - 3
+  version: "1.3"
 platform: ruby
 authors: 
 - Andrey Tarantsov
@@ -45,7 +44,21 @@ dependencies:
         version: 1.3.2
   type: :runtime
   version_requirements: *id002
-description: A command-line server for the LiveReload Safari extension
+- !ruby/object:Gem::Dependency 
+  name: ruby-json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  version_requirements: *id003
+description: "        LiveReload is a Safari/Chrome extension + a command-line tool that:\n        1. Applies CSS and JavaScript file changes without reloading a page.\n        2. Automatically reloads a page when any other file changes (html, image, server-side script, etc).\n"
 email: andreyvit@gmail.com
 executables: 
 - livereload
@@ -85,6 +98,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A command-line server for the LiveReload Safari extension
+summary: A command-line server for the LiveReload Safari/Chrome extension
 test_files: []