guard 0.1.0.beta.1 → 0.1.0

data/README.rdoc

@@ -1,3 +1,155 @@
 = Guard
 
-Documentation is coming.
+Guard is a command line tool to easly handle events on files modifications.
+
+== Features
+
+- FSEvent support on Mac OS X (without RubyCocoa!)
+- Inotify support on Linux (beta)
+- Super fast change detection
+- Automatic files modifications detection (even new files are detected)
+- Growl notification (please install {growlnotify}[http://growl.info/documentation/growlnotify.php])
+- Libnotify notification
+
+== Install
+
+Only Mac OS X (10.5+) & Linux are supported. Tested on Ruby 1.8.7 & 1.9.2dev.
+
+Install the gem:
+
+    gem install guard
+
+Add it to your Gemfile (inside test group):
+
+    gem 'guard'
+
+Generate an empty Guardfile with:
+
+    guard init
+
+Add guard(s) you need (see available guards below)
+
+== Usage
+
+Just launch Guard inside your ruby/rails project with:
+
+    guard
+
+Options list is available with:
+
+    guard help
+
+Signal handlers are used to interact with Guard:
+
+- Ctrl-C - Quit Guard (call stop guard(s) method before)
+- Ctrl-\ - Call run_all guard(s) method
+- Ctrl-Z - Call reload guard(s) method
+
+== Available Guards
+
+- {guard-rspec}[http://github.com/guard/guard-rspec]
+
+guard ideas:
+
+- guard-spork
+- guard-livereload
+- guard-cucumber
+- guard-test
+- guard-sass
+- guard-bundler
+- others ideas?
+
+=== Add a guard to your Guardfile
+
+Add it to your Gemfile (inside test group):
+
+    gem '<guard-name>'
+
+Add guard definition to your Guardfile with:
+
+    guard init <guard-name>
+
+You are good to go!
+
+== Create a guard
+
+Create a new guard is very easy, just create a new gem with this basic structure:
+
+    - lib/
+      - guard/
+        - guard-name/
+          - templates/
+            - Guardfile (needed for guard init <guard-name>)
+        - guard-name.rb
+
+lib/guard/guard-name.rb inherit from guard/guard and should overwrite at least one of the five guard methods. Example:
+
+    require 'guard'
+    require 'guard/guard'
+    
+    module Guard
+      class GuardName < Guard
+        
+        # ================
+        # = Guard method =
+        # ================
+        
+        # Call once when guard starts
+        def start
+          true
+        end
+        
+        # Call with Ctrl-C signal (when Guard quit)
+        def stop
+          true
+        end
+        
+        # Call with Ctrl-Z signal
+        def reload
+          true
+        end
+        
+        # Call with Ctrl-/ signal
+        def run_all
+          true
+        end
+        
+        # Call on file(s) modifications
+        def run_on_change(paths)
+          true
+        end
+        
+      end
+    end
+
+Looks at available guards code for more concrete example.
+
+== Guardfile DSL
+
+Guardfile DSL consists of just 2 simple methods: guard & watch. Example:
+
+    guard 'rspec', :version => 2 do
+      watch('^spec/(.*)_spec.rb')
+      watch('^lib/(.*)\.rb')        { |m| "spec/lib/#{m[1]}_spec.rb" }
+      watch('^spec/spec_helper.rb') { "spec" }
+      watch('^spec/spec_helper.rb') { `say hello` }
+    end
+    
+- "guard" method allow to add a guard with an optional options hash
+- "watch" method allow to define which files are supervised per this guard. A optional block can be added to overwrite path sending to run_on_change guard method or launch simple command.
+
+== TODO
+
+- Add more specs, help are welcome because I'm not sure about how to test stuff like this :-)
+
+== Development
+
+- Source hosted at {GitHub}[http://github.com/guard/guard]
+- Report issues/Questions/Feature requests on {GitHub Issues}[http://github.com/guard/guard/issues]
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
+you make.
+
+== Authors
+
+{Thibaud Guillaume-Gentil}[http://github.com/thibaudgg].

data/lib/guard/cli.rb

@@ -8,13 +8,30 @@ module Guard
     desc "start", "Starts guard"
     method_option :clear, :type => :boolean, :default => false, :aliases => '-c', :banner => "Auto clear shell after each change"
     def start
-      Guard.start(options)
+      ::Guard.start(options)
     end
     
     desc "version", "Prints the guard's version information"
     def version
-      Guard::UI.info "Guard version #{Guard::VERSION}"
+      ::Guard::UI.info "Guard version #{Guard::VERSION}"
     end
     map %w(-v --version) => :version
+    
+    desc "init [GUARD]", "Generates a Guardfile into the current working directory, or add it given guard"
+    def init(guard_name = nil)
+      if !File.exist?("Guardfile")
+        puts "Writing new Guardfile to #{Dir.pwd}/Guardfile"
+        FileUtils.cp(File.expand_path('../templates/Guardfile', __FILE__), 'Guardfile')
+      elsif guard_name.nil?
+        ::Guard::UI.error "Guardfile already exists at #{Dir.pwd}/Guardfile"
+        exit 1
+      end
+      
+      if guard_name
+        guard_class = ::Guard.get_guard_class(guard_name)
+        guard_class.init(guard_name)
+      end
+    end
+    
   end
 end

data/lib/guard/dsl.rb

@@ -10,14 +10,18 @@ module Guard
       exit 1
     end
     
+    def self.guardfile_included?(guard_name)
+      File.read('Guardfile').include?("guard '#{guard_name}'")
+    end
+    
     def guard(name, options = {}, &definition)
       @watchers = []
-      definition.call
-      Guard.add_guard(name, @watchers, options)
+      definition.call if definition
+      ::Guard.add_guard(name, @watchers, options)
     end
     
     def watch(pattern, &action)
-      @watchers << Guard::Watcher.new(pattern, action)
+      @watchers << ::Guard::Watcher.new(pattern, action)
     end
     
   end

data/lib/guard/guard.rb

@@ -6,6 +6,22 @@ module Guard
       @watchers, @options = watchers, options
     end
     
+    # Guardfile template needed inside guard gem
+    def self.init(name)
+      if ::Guard::Dsl.guardfile_included?(name)
+        ::Guard::UI.info "Guardfile already include #{name} guard"
+      else
+        content = File.read('Guardfile')
+        guard   = File.read("#{::Guard.locate_guard(name)}/lib/guard/#{name}/templates/Guardfile")
+        File.open('Guardfile', 'wb') do |f|
+          f.puts content
+          f.puts ""
+          f.puts guard
+        end
+        ::Guard::UI.info "#{name} guard added to Guardfile, feel free to edit it"
+      end
+    end
+    
     # ================
     # = Guard method =
     # ================

data/lib/guard/listener.rb

@@ -50,6 +50,8 @@ module Guard
     
     def recent_file?(file)
       File.mtime(file) >= last_event
+    rescue
+      false
     end
     
     def update_last_event

data/lib/guard/templates/Guardfile

@@ -0,0 +1,2 @@
+# A sample Guardfile
+# More info at http://github.com/guard/guard#readme

data/lib/guard/ui.rb

@@ -5,7 +5,7 @@ module Guard
       def info(message, options = {})
         unless ENV["GUARD_ENV"] == "test"
           reset_line if options[:reset]
-          clear      if options.key?(:clear) ? options[:clear] : ::Guard.options[:clear]
+          clear      if options.key?(:clear) ? options[:clear] : (::Guard.options && ::Guard.options[:clear])
           puts reset_color(message) if message != ''
         end
       end

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "0.1.0.beta.1"
+  VERSION = "0.1.0"
 end

data/lib/guard/watcher.rb

@@ -12,11 +12,10 @@ module Guard
           if matches = file.match(watcher.pattern)
             if watcher.action
               begin 
-                case watcher.action.arity
-                when -1
-                  result = watcher.action.call
-                when 1
+                if watcher.action.arity == 1
                   result = watcher.action.call(matches)
+                else
+                  result = watcher.action.call
                 end
               rescue
                 UI.info "Problem with watch action"

data/lib/guard.rb

@@ -1,3 +1,5 @@
+require 'bundler'
+
 module Guard
   
   autoload :UI,         'guard/ui'
@@ -16,26 +18,42 @@ module Guard
       @guards   = []
       
       Dsl.evaluate_guardfile
-      Interactor.init_signal_traps
-      
-      listener.on_change do |files|
-        run do
-          guards.each do |guard|
-            paths = Watcher.match_files(guard, files)
-            guard.run_on_change(paths) unless paths.empty?
+      if guards.empty?
+        UI.error "No guards found in Guardfile, please add it at least one."
+      else
+        Interactor.init_signal_traps
+        
+        listener.on_change do |files|
+          run do
+            guards.each do |guard|
+              paths = Watcher.match_files(guard, files)
+              guard.run_on_change(paths) unless paths.empty?
+            end
           end
         end
+        
+        UI.info "Guard is now watching at '#{Dir.pwd}'"
+        guards.each(&:start)
+        listener.start
       end
-      
-      UI.info "Guard is now watching at '#{Dir.pwd}'"
-      guards.each(&:start)
-      listener.start
     end
     
     def add_guard(name, watchers = [], options = {})
+      guard_class = get_guard_class(name)
+      @guards << guard_class.new(watchers, options)
+    end
+    
+    def get_guard_class(name)
       require "guard/#{name.downcase}"
       guard_class = ObjectSpace.each_object(Class).detect { |c| c.to_s.downcase.match "^guard::#{name.downcase}" }
-      @guards << guard_class.new(watchers, options)
+    rescue LoadError
+      UI.error "#{name} guard gem not found, try to add it to your Gemfile."
+    end
+    
+    def locate_guard(name)
+      spec = Bundler.load.specs.find{|s| s.name == "guard-#{name}" }
+      UI.error "Could not find gem '#{name}' in the current Gemfile." unless spec
+      spec.full_gem_path
     end
     
     def run
@@ -45,5 +63,4 @@ module Guard
     end
     
   end
-  
 end

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard
 version: !ruby/object:Gem::Version 
-  hash: 62196401
-  prerelease: true
+  hash: 27
+  prerelease: false
   segments: 
   - 0
   - 1
   - 0
-  - beta
-  - 1
-  version: 0.1.0.beta.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Thibaud Guillaume-Gentil
@@ -17,63 +15,78 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-03 00:00:00 +02:00
+date: 2010-10-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 7712058
         segments: 
-        - 1
+        - 2
         - 0
-        - 1
-        version: 1.0.1
+        - 0
+        - rc
+        version: 2.0.0.rc
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: guard-rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 62196431
+        hash: 27
         segments: 
-        - 2
         - 0
+        - 1
         - 0
-        - beta
-        - 22
-        version: 2.0.0.beta.22
+        version: 0.1.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: thor
+  name: bundler
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 35
+        hash: 19
         segments: 
+        - 1
         - 0
-        - 14
         - 2
-        version: 0.14.2
+        version: 1.0.2
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: sys-uname
+  name: thor
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 0
+        - 14
+        - 3
+        version: 0.14.3
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sys-uname
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -85,11 +98,11 @@ dependencies:
         - 4
         version: 0.8.4
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: growl
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -101,25 +114,27 @@ dependencies:
         - 3
         version: 1.0.3
   type: :runtime
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rb-inotify
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 61
         segments: 
         - 0
-        version: "0"
+        - 8
+        - 1
+        version: 0.8.1
   type: :runtime
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: libnotify
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -131,8 +146,8 @@ dependencies:
         - 3
         version: 0.1.3
   type: :runtime
-  version_requirements: *id007
-description: Guard is a command line tool to easly manage script launch when your files change
+  version_requirements: *id008
+description: Guard is a command line tool to easly handle events on files modifications.
 email: 
 - thibaud@thibaud.me
 executables: 
@@ -153,6 +168,7 @@ files:
 - lib/guard/interactor.rb
 - lib/guard/listener.rb
 - lib/guard/notifier.rb
+- lib/guard/templates/Guardfile
 - lib/guard/ui.rb
 - lib/guard/version.rb
 - lib/guard/watcher.rb
@@ -182,20 +198,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 23
       segments: 
       - 1
       - 3
-      - 1
-      version: 1.3.1
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: guard
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Guard keep an eye on your files event
+summary: Guard keep an eye on your files modifications.
 test_files: []