capistrano-syntax-checking 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Alexander Staubo
+
+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.

data/LICENSE.closure

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.markdown

@@ -0,0 +1,51 @@
+This is a simple extension to Capistrano that adds a few tasks to syntax-check source files.
+
+Installation
+------------
+
+Install via gems:
+
+    gem install capistrano-syntax-checking
+
+Usage with Rails
+----------------
+
+To use with a Rails application with sensible default, put the following at the 
+top of your `Capfile`:
+
+    require 'capistrano/recipes/syntax_checking'
+
+Then add this at the bottom of your `Capfile`, _outside_ the `namespace deploy do ...`
+block:
+
+    before 'deploy:update', :check_syntax
+
+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
+-----------------------------------------------------------------------------
+
+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 
+top of your `Capfile`:
+
+    require 'capistrano/ext/syntax_checking'
+
+Then build your own tasks by calling the syntax check API, perhaps like this:
+
+    task :deploy do
+      Capistrano::SyntaxChecking.check_javascript('src', :verbose => false)
+    end
+
+Licensing
+---------
+
+* This source code is copyright Alexander Staubo. The code is licensed under the
+  MIT license. See LICENSE for the license text.
+
+* The library comes with a binary compiled version of the Google Closure 
+  compiler, which is copyright Google Corp. and licensed under the Apache License.
+  See the file LICENSE.closure for the license text.

data/README.rdoc

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

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/capistrano/ext/syntax_checking.rb

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

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

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+module Capistrano
+  module SyntaxChecks
+
+    class << self
+      
+      # Check ERB syntax. 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_erb(paths, options = {})
+        verbose = options[:verbose]
+        begin
+          require "erb"
+          errors = false
+          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, "-")
+              begin
+                template.result
+              rescue SyntaxError => e
+                $stderr << "\rSyntax error in ERB template #{file_name}: #{e}\n"
+                $stderr.flush
+                errors = true
+              rescue Exception
+                # Ignore
+              end
+            ensure
+              $stderr = old_stderr
+            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
+        rescue Interrupt
+          if verbose
+            puts
+          end
+          puts("Canceled, skipping.")
+        end
+      end
+   
+    end
+
+  end
+end

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

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module Capistrano
+  module SyntaxChecks
+
+    class << self
+
+      # Check syntax in JavaScript 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_javascript(paths, options = {})
+        verbose = options[:verbose]
+        begin
+          errors = false
+          file_names = [paths].flatten.compact.map { |path|
+            Dir.glob(File.join(path, "**", "*.js"))
+          }.flatten
+          if file_names.any?
+            jar_path = File.join(File.dirname(__FILE__), "../../../closure/compiler.jar")
+            if verbose
+              print("Checking #{file_names.length} files with Closure")
+            end
+            command_line = "java -jar #{jar_path} " <<
+              "--compilation_level WHITESPACE_ONLY " <<
+              "--process_closure_primitives false " <<
+              "--warning_level QUIET " <<
+              "--js_output_file /dev/null " <<
+              "--third_party "
+            command_line << file_names.map { |fn| "--js '#{fn}' 2>&1"}.join(' ')
+            IO.popen(command_line, 'r') do |input|
+              input.each_line do |line|
+                unless line =~ /^\d+ error(s)/
+                  print("\r")
+                  puts(line)
+                end
+                errors = true
+              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
+          else
+            if verbose
+              puts("No JavaScript files to check.")
+            end
+          end
+        rescue Interrupt
+          if verbose
+            puts
+          end
+          puts("Canceled, skipping.")
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module Capistrano
+  module SyntaxChecks
+
+    class << self
+
+      # Check syntax in Ruby 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_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.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
+                end
+              end
+            end
+          end
+          if errors
+            print("\r")
+            abort("One or more syntax errors found. Fix and try again.")
+          else
+            puts ", no problems found."
+          end
+        rescue Interrupt
+          puts
+          puts("Canceled, skipping.")
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/capistrano/recipes/syntax_checking.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'capistrano'
+require 'capistrano/ext/syntax_checking/erb'
+require 'capistrano/ext/syntax_checking/javascript'
+require 'capistrano/ext/syntax_checking/ruby'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "Capistrano syntax checks extensions requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+  namespace :check_syntax do
+
+    desc "Check syntax of all files"
+    task :default do
+      ruby
+      erb
+      javascript
+    end
+
+    desc "Test syntax of all JavaScript files"
+    task :javascript do
+      Capistrano::SyntaxChecks.check_javascript('public/javascripts', :verbose => true)
+    end
+
+    desc "Test syntax of all Ruby files"
+    task :ruby do
+      Capistrano::SyntaxChecks.check_ruby(%w(app lib), :verbose => true)
+    end
+
+    desc "Test syntax of all ERB files"
+    task :erb do
+      Capistrano::SyntaxChecks.check_erb('app', :verbose => true)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-syntax-checking
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alexander Staubo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+description: Capistrano extension that adds syntax checks for Ruby, ERB and JavaScript files.
+email: alex@bengler.no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- LICENSE.closure
+- README.markdown
+- README.rdoc
+files: 
+- LICENSE
+- LICENSE.closure
+- README.markdown
+- VERSION
+- lib/capistrano/ext/syntax_checking.rb
+- lib/capistrano/ext/syntax_checking/erb.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: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Capistrano extension that adds syntax checks for Ruby, ERB and JavaScript files.
+test_files: []
+