capistrano-syntax-checking 0.1.1 → 0.1.2

data/README.markdown

@@ -11,8 +11,8 @@ Install via gems:
 
     gem install capistrano-syntax-checking
 
-Usage with Rails
-----------------
+Usage with Rails and Capistrano's standard Rails recipe
+-------------------------------------------------------
 
 To use with a Rails application with sensible default, put the following at the 
 top of your `Capfile`:
@@ -29,11 +29,37 @@ To invoke only certain checks, such as only Ruby and ERB:
     before 'deploy:update', "check_syntax:ruby"
     before 'deploy:update', "check_syntax:erb"
     
-Usage with generic (non-Rails) application, or when you want to be in control
------------------------------------------------------------------------------
+Using without Capistrano's standard Rails recipe, or with non-Rails apps
+------------------------------------------------------------------------
+
+If you are not using the Capistrano's built-in Rails support, start the same way:
+
+    require 'capistrano/recipes/syntax_checking'
+
+Then override all the paths to match your application exactly:
+
+    set :syntax_check_paths,
+      :ruby => ["lib/ruby"]     # These are just examples
+      :erb => ["lib/erb"],
+      :javascript => ["public/js"]
+      
+Then make sure the syntax checks are invoked before your deploy task. If your
+deploy task is named "push", then:
+
+    desc "Full deploy ahead!"
+    task :push do
+      # ... your stuff here ...
+    end
+    before :push, :check_syntax
+    
+Refer to Capistrano's documentation on how to otherwise structure your 
+deployment file.
+
+Using the API directly
+----------------------
 
 To use with any other kind of application, you will want to use your own tasks 
-that providecustom options to the syntax-checker. Start by putting this at the 
+that provide custom options to the syntax-checker. Start by putting this at the 
 top of your `Capfile`:
 
     require 'capistrano/ext/syntax_checking'

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/capistrano/ext/syntax_checking/erb.rb

@@ -19,37 +19,41 @@ module Capistrano
           file_names = [paths].flatten.compact.map { |path|
             Dir.glob(File.join(path, "**", "*.{erb,rhtml}"))
           }.flatten
-          file_names.each_with_index do |file_name, index|
-            if verbose
-              $stdout.write("\r#{index} files checked (ctrl-C to skip)")
-              $stdout.flush
-            end
-            old_stderr = $stderr
-            begin
-              $stderr = File.open("/dev/null", 'w')
-              template = ERB.new(File.read(file_name), nil, "-")
+          if file_names.any?
+            file_names.each_with_index do |file_name, index|
+              if verbose
+                $stdout.write("\r#{index} files checked (ctrl-C to skip)")
+                $stdout.flush
+              end
+              old_stderr = $stderr
               begin
-                template.result
-              rescue SyntaxError => e
-                $stderr << "\rSyntax error in ERB template #{file_name}: #{e}\n"
-                $stderr.flush
-                errors = true
-              rescue Exception
-                # Ignore
+                $stderr = File.open("/dev/null", 'w')
+                template = ERB.new(File.read(file_name), nil, "-")
+                begin
+                  template.result
+                rescue SyntaxError => e
+                  old_stderr << "\rSyntax error in ERB template #{file_name}: #{e}\n"
+                  old_stderr.flush
+                  errors = true
+                rescue Exception
+                  # Ignore
+                end
+              ensure
+                $stderr = old_stderr
               end
-            ensure
-              $stderr = old_stderr
             end
-          end
-          if errors
-            if verbose
-              print "\r"
+            if errors
+              if verbose
+                print "\r"
+              end
+              abort("One or more syntax errors found. Fix and try again.")
+            else
+              if verbose
+                puts ", no problems found."
+              end
             end
-            abort("One or more syntax errors found. Fix and try again.")
           else
-            if verbose
-              puts ", no problems found."
-            end
+            puts("No ERB files to check.")
           end
         rescue Interrupt
           if verbose

data/lib/capistrano/recipes/syntax_checking.rb

@@ -19,6 +19,7 @@ Capistrano::Configuration.instance.load do
       erb
       javascript
       haml
+      puts
     end
 
     desc "Test syntax of all JavaScript files"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-syntax-checking
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Alexander Staubo
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 +02:00
+date: 2010-08-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency