capistrano-syntax-checking 0.1.0 → 0.1.1

data/README.markdown

@@ -1,4 +1,8 @@
-This is a simple extension to Capistrano that adds a few tasks to syntax-check source files.
+This is a simple extension to Capistrano that adds a few pre-deploy 
+syntax-checks for source files.
+
+Currently supported syntaxes are Ruby, ERB, JavaScript (using the Google
+Closure compiler) and HAML.
 
 Installation
 ------------
@@ -40,6 +44,25 @@ Then build your own tasks by calling the syntax check API, perhaps like this:
       Capistrano::SyntaxChecking.check_javascript('src', :verbose => false)
     end
 
+Configuration
+-------------
+
+You can override the paths that the checker will look in. For the Rails
+recipe, the paths are the usual directoryes -- `app`, `lib` and `config` for
+Ruby files, `app/views` for ERB, and so on. If your Rails layout is a little
+different, then you may have to extend the path list.
+
+To override the path list, set the `syntax_check_paths` variable in
+Capistrano. For example:
+
+    set :syntax_check_paths, :ruby => %w(app lib bin config vendor)
+    
+The keys you may override are `:ruby`, `:erb`, `:javascript` and `:haml`.
+
+You can also override the task output verbosity:
+
+     set :syntax_check_verbose, false
+
 Licensing
 ---------
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/capistrano/ext/syntax_checking.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'capistrano'
-require "capistrano/ext/syntax_checking/erb"
-require "capistrano/ext/syntax_checking/javascript"
-require "capistrano/ext/syntax_checking/ruby"
+require 'capistrano/ext/syntax_checking/erb'
+require 'capistrano/ext/syntax_checking/javascript'
+require 'capistrano/ext/syntax_checking/ruby'
+require 'capistrano/ext/syntax_checking/haml'

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

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+begin
+  require 'haml'
+rescue LoadError
+  # Ignore
+end
+
+module Capistrano
+  module SyntaxChecks
+
+    class << self
+
+      # Check syntax in HAML files. The +paths+ argument takes a single string 
+      # or array of paths to check. Options may be:
+      #
+      # * +verbose+ - if true, enable verbose output to standard output. If false,
+      #   only errors will be output.
+      #
+      def check_haml(paths, options = {})
+        if defined?(::Haml)          
+          verbose = options[:verbose]
+          begin
+            errors = false
+            file_names = [paths].flatten.compact.map { |path|
+              Dir.glob(File.join(path, "**", "*.haml"))
+            }.flatten
+            file_names.delete_if { |d| File.directory?(d) }
+            if file_names.any?
+              file_names.each_with_index do |file_name, index|
+                begin
+                  ::Haml::Engine.new(File.read(file_name), :cache => false, :read_cache => false)
+                rescue => e
+                  puts "\r#{file_name}:#{e.line}: #{e.message}"
+                  errors = true
+                end
+                if verbose
+                  $stdout.write("\r#{index + 1} files checked (ctrl-C to skip)")
+                  $stdout.flush
+                end
+              end
+              if errors
+                print("\r")
+                abort("One or more syntax errors found. Fix and try again.")
+              else
+                puts ", no problems found."
+              end
+            else
+              if verbose
+                puts("No HAML files to check.")
+              end
+            end
+          rescue Interrupt
+            puts
+            puts("Canceled, skipping.")
+          end
+        else
+          $stderr << "HAML syntax checks disabled as HAML is not installed.\n"
+        end
+      end
+      
+    end
+
+  end
+end

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

@@ -14,39 +14,46 @@ module Capistrano
       def check_ruby(paths, options = {})
         verbose = options[:verbose]
         begin
-          ignore_patterns = %w(
-          )
           errors = false
-          directories = %w(
-            app
-            bin
-            lib
-            config
-          )
-          files = directories.map { |d| Dir.glob(File.join(d, "**", "*.rb")) }.flatten
+          files = [paths].flatten.compact.map { |path|
+            Dir.glob(File.join(path, "**", "*.rb"))
+          }.flatten
           files.delete_if { |d| File.directory?(d) }
-          files.delete_if { |d| ignore_patterns.find { |p| d.index(p) } }
-          files.each_with_index do |file_name, index|
-            $stdout.write("\r#{index} files checked (ctrl-C to skip)")
-            $stdout.flush
-            IO.popen("ruby -c '#{file_name}' 2>&1", "r") do |input|
-              input.each_line do |line|
-                unless line =~ /Syntax OK|\d: warning:/
-                  print("\r")
-                  puts(line)
-                  errors = true
+          if files.any?
+            files.each_with_index do |file_name, index|
+              IO.popen("ruby -c '#{file_name}' 2>&1", "r") do |input|
+                input.each_line do |line|
+                  unless line =~ /Syntax OK|\d: warning:/
+                    print("\r")
+                    puts(line)
+                    errors = true
+                  end
                 end
               end
+              if verbose
+                $stdout.write("\r#{index + 1} files checked (ctrl-C to skip)")
+                $stdout.flush
+              end
+            end
+            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
-          end
-          if errors
-            print("\r")
-            abort("One or more syntax errors found. Fix and try again.")
           else
-            puts ", no problems found."
+            if verbose
+              puts("No files to check.")
+            end
           end
         rescue Interrupt
-          puts
+          if verbose
+            puts
+          end
           puts("Canceled, skipping.")
         end
       end

data/lib/capistrano/recipes/syntax_checking.rb

@@ -4,6 +4,7 @@ require 'capistrano'
 require 'capistrano/ext/syntax_checking/erb'
 require 'capistrano/ext/syntax_checking/javascript'
 require 'capistrano/ext/syntax_checking/ruby'
+require 'capistrano/ext/syntax_checking/haml'
 
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "Capistrano syntax checks extensions requires Capistrano 2"
@@ -17,21 +18,46 @@ Capistrano::Configuration.instance.load do
       ruby
       erb
       javascript
+      haml
     end
 
     desc "Test syntax of all JavaScript files"
     task :javascript do
-      Capistrano::SyntaxChecks.check_javascript('public/javascripts', :verbose => true)
+      paths = fetch(:syntax_check_paths, {})[:javascript]
+      paths ||= %w(
+        public/javascripts
+      )
+      Capistrano::SyntaxChecks.check_javascript(paths, :verbose => fetch(:syntax_check_verbose, true))
     end
 
     desc "Test syntax of all Ruby files"
     task :ruby do
-      Capistrano::SyntaxChecks.check_ruby(%w(app lib), :verbose => true)
+      paths = fetch(:syntax_check_paths, {})[:ruby]
+      paths ||= %w(
+        app 
+        lib
+        config
+        scripts
+      )
+      Capistrano::SyntaxChecks.check_ruby(paths, :verbose => fetch(:syntax_check_verbose, true))
     end
 
     desc "Test syntax of all ERB files"
     task :erb do
-      Capistrano::SyntaxChecks.check_erb('app', :verbose => true)
+      paths = fetch(:syntax_check_paths, {})[:erb]
+      paths ||= %w(
+        app 
+      )
+      Capistrano::SyntaxChecks.check_erb(paths, :verbose => fetch(:syntax_check_verbose, true))
+    end
+
+    desc "Test syntax of all HAML files"
+    task :haml do
+      paths = fetch(:syntax_check_paths, {})[:haml]
+      paths ||= %w(
+        app
+      )
+      Capistrano::SyntaxChecks.check_haml(paths, :verbose => fetch(:syntax_check_verbose, true))
     end
 
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-syntax-checking
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Alexander Staubo
@@ -43,7 +43,6 @@ extra_rdoc_files:
 - LICENSE
 - LICENSE.closure
 - README.markdown
-- README.rdoc
 files: 
 - LICENSE
 - LICENSE.closure
@@ -51,11 +50,11 @@ files:
 - VERSION
 - lib/capistrano/ext/syntax_checking.rb
 - lib/capistrano/ext/syntax_checking/erb.rb
+- lib/capistrano/ext/syntax_checking/haml.rb
 - lib/capistrano/ext/syntax_checking/javascript.rb
 - lib/capistrano/ext/syntax_checking/ruby.rb
 - lib/capistrano/recipes/syntax_checking.rb
 - lib/closure/compiler.jar
-- README.rdoc
 has_rdoc: true
 homepage: http://github.com/alexstaubo/capistrano-syntax-checking
 licenses: []

data/README.rdoc

@@ -1 +0,0 @@
-This is a simple extension to Capistrano that adds a few tasks to syntax-check source files.