ci-syntax-tool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12e0cbc5efe12dc146a5ede4094ea62f0137915d
+  data.tar.gz: 480b4eff820df5aac1ad736330918492f5a9324b
+SHA512:
+  metadata.gz: c77c377d030d48e67134ef124633a1d2307288cbe0f6f00cc5fdc9bd4636c966b530ad65bf2971b0ba2cdac55d055f9ec32da99c193fb661cf59fc2aed49b555
+  data.tar.gz: 55f16c7324455770784844f16243c2038b2371e1cd1a95602658c3d122c815204458bd6507d2d0944850b91f3bcba8ef52fecee80009cf99a28baf4303eda837

data/.gitignore

@@ -0,0 +1,3 @@
+*~
+pkg/*
+test/tmp/*

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2015, Clinton Wolfe
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of 'ci-syntax-tool' nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,109 @@
+# CI Syntax Tool
+
+## Overview
+
+Checks various source file types for syntax errors, and formats the results in a flexible way.
+
+## Command Line Options
+
+| Short | Long | Description |
+|-------|------|-------------|
+| -V    | --version | Show ci-syntax-tool version |
+| -h    | --help    | Show this help message |
+| -l    | --lang LANG| Select this language for checking.  Repeatable.  Default, all languages.|
+|       | --list-languages | List available languages and exit |
+| -f    | --format FORMAT  | Use this format for output.  Repeatable, but if repeated, must have an equal number of --output options.|
+| -o    | --output PATH    | Write formatted output to this location.  Use "-" to represent STDOUT.  Defaults to STDOUT if zero or one --format option used.  Repeatable with an equal number of --format options.'|
+|       | --list-formats   | List available formats and exit.|
+| -r    | --require RUBYFILE | Load additional Ruby code, perhaps for a custom language or format.  Repeatable. |
+| -d    | --debug | Provide debug-level output to STDOUT.|
+
+## Exit codes
+
+### 0
+
+Success - no files contained errors, or an option was given that did not involve a scan.
+
+### 1
+
+At least one file contained an error.
+
+### 2
+
+Reserved.
+
+### 3
+
+All usage errors related to selecting or loading a Language plugin.  See STDERR for details, and possibly add --debug.
+
+### 4
+
+All usage errors related to selecting or loading a Format plugin.  See STDERR for details, and possibly add --debug.
+
+### 5
+
+All usage errors related to the --require option.  See STDERR for details, and possibly add --debug.
+
+### 6
+
+You specified a path to check that does not exist.
+
+## Examples
+
+### With no options
+
+`ci-syntax-tool`
+
+Loads all core syntax plugins, then uses their globs to match all files below the current directory, printing a report to STDOUT using the Progress format.  If any errors are seen, exit code 1, otherwise exit 0.
+
+This might be good enough for a commit hook.
+
+### Force a language to match a particular file
+
+`ci-syntax-tool --lang YAML SomeYamlFile.txt
+
+If a file doesn't have an extension that would match the usual glob, you can specify one or more filenames, bypassing the globbing mechanism.  Use --lang to keep it restricted to only the language you know you want.  Again, the default Progress format sends a report to STDOUT.
+
+## Language Syntax Plugins
+
+So far, we support:
+
+### YAML
+
+Using the ruby Psych parser.
+
+### Adding Your Own
+
+Extend CI::Syntax::Tool::Language::Base, and use --require to include your library.
+
+## Output Format Plugins
+
+So far, we support:
+
+### JUnit
+
+Produces an XML report that is jUnit/nUnit/SureFire compatible, probably.  Many CI engines can read this, but how they interpret it varies.
+
+### Progress
+
+The default format.  Prints a '.', '*', or 'x' for each file that is clean, has nonzero warnings, or nonzero errors, respectively, followed by a list of problematic files.
+
+### Adding Your Own
+
+Extend CI::Syntax::Tool::Format::Base, and use --require to include your library.
+
+## Bugs and Defects
+
+Perfect, AFAIK.
+
+## Author
+
+Clinton Wolfe
+
+## Contributing
+
+1. Fork it (https://github.com/omniti-labs/ci-syntax-tool)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request at (https://github.com/omniti-labs/ci-syntax-tool)

data/Rakefile

@@ -0,0 +1,43 @@
+# -*-ruby-*-
+
+require 'rake'
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+namespace :test do
+  desc 'Checks ruby files for syntax errors'
+  task :syntax do
+    puts '------------Syntax-----------'
+    Dir.glob('**/*.rb').each do |f|
+      system("/bin/echo -n '#{f}:  '; ruby -c #{f}")
+    end
+  end
+
+  desc 'Run unit tests'
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'test/unit/**/*_spec.rb'
+  end
+
+  desc 'Run RuboCop'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.options = ['-c', 'rubocop.yml']
+    task.patterns = ['bin/*', 'lib/**/*.rb', 'Rakefile']
+  end
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = ['-f', 'progress', '--strict']
+    unless ENV.key?('FC_FORK_PROCESS') \
+          && ENV['FC_FORK_PROCESS'] == true.to_s
+      t.cucumber_opts += ['-t', '~@build']
+      t.cucumber_opts += ['-t', '~@context']
+    end
+    t.cucumber_opts += ['test/features']
+  end
+end
+
+desc 'Runs all development tests'
+task test: [:'test:syntax', :'test:rubocop', :'test:unit', :'test:features']

data/bin/ci-syntax-tool

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'ci-syntax-tool'
+module CI
+  module Syntax
+    # CI::Syntax::Tool - binstub
+    module Tool
+      cmd_line = CommandLine.new(ARGV)
+      status = Checker.new(cmd_line).run
+      exit status.to_i
+    end
+  end
+end

data/ci-syntax-tool.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8    # -*-ruby-*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ci-syntax-tool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ci-syntax-tool"
+  spec.version       = CI::Syntax::Tool::VERSION
+  spec.authors       = ["Clinton Wolfe"]
+  spec.email         = ["clinton@omniti.com"]
+  spec.description   = %q{Checks YAML, JSON, Ruby, ERB, and other syntaxes, then reports errors and OKs in a nice way for your CI system.}
+  spec.summary       = %q{A Rubygem implementing a suite of source code syntax checkers, with well-behaved output fo use with CI engines.}
+  spec.homepage      = "https://github.com/clintoncwolfe/ci-syntax-tool"
+  spec.license       = "BSD (3-clause)"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", '~> 0.8'
+  spec.add_development_dependency "cucumber", '~> 2.0'
+  spec.add_development_dependency "rubocop", '~> 0.28'
+  spec.add_runtime_dependency "nokogiri", '~> 1.6'
+
+end

data/lib/ci-syntax-tool.rb

@@ -0,0 +1,6 @@
+require 'ci-syntax-tool/version'
+require 'ci-syntax-tool/command_line'
+require 'ci-syntax-tool/result'
+require 'ci-syntax-tool/checker'
+require 'ci-syntax-tool/language_factory'
+require 'ci-syntax-tool/format_factory'

data/lib/ci-syntax-tool/checker.rb

@@ -0,0 +1,63 @@
+module CI
+  module Syntax
+    module Tool
+      # CI::Syntax::Tool::Checker
+      #  Main driver of the tool.  For each language,
+      #  locates files, runs the check, and outputs
+      #  to each formatter.
+      class Checker
+        attr_reader :cmd_line
+        attr_reader :overall_result
+
+        def initialize(cmd_line)
+          @cmd_line = cmd_line
+        end
+
+        def run
+
+          formats = []
+          cmd_line.options[:formats].each_with_index do |fmt_name, idx|
+            formats << FormatFactory.create(fmt_name, cmd_line.options[:outputs][idx])
+          end
+          
+          @overall_result = Result::OverallResult.new()
+          formats.each { |fmt| fmt.overall_started(overall_result) }
+          
+          cmd_line.options[:languages].each do |lang_name|
+            language_result = overall_result.add_language_result(lang_name)
+            lang = LanguageFactory.create(lang_name)
+            
+            lang.check_starting(language_result)
+            formats.each { |fmt| fmt.lang_started(language_result) }
+            
+            cmd_line.file_args.each do |argpath|
+              if FileTest.directory?(argpath)
+                Dir.chdir(argpath) do                  
+                  Dir.glob(lang.combined_globs).each do |path|
+                    file_result = language_result.add_file_result(path)
+                    formats.each { |fmt| fmt.file_started(file_result) }
+                    lang.check_file(file_result)
+                    formats.each { |fmt| fmt.file_finished(file_result) }
+                  end
+                end
+              else
+                # No glob check here - user explicitly specified a file
+                file_result = language_result.add_file_result(argpath)
+                formats.each { |fmt| fmt.file_started(file_result) }
+                lang.check_file(file_result)
+                formats.each { |fmt| fmt.file_finished(file_result) }
+              end
+            end
+            lang.check_ending(language_result)
+            formats.each { |fmt| fmt.lang_finished(language_result) }
+          end
+
+          formats.each { |fmt| fmt.overall_finished(overall_result) }
+          return overall_result.report_failure? ? 1 : 0
+          
+        end
+        
+      end
+    end
+  end
+end

data/lib/ci-syntax-tool/command_line.rb

@@ -0,0 +1,229 @@
+
+require 'optparse'
+
+module CI
+  module Syntax
+    module Tool
+      # CI::Syntax::Tool::CommandLine
+      #   a class to parse and represent the CLI options
+      #   also handles degenerate CLI cases, like --help,
+      #   --version, --list-languages, --list-formatters
+      class CommandLine
+        attr_accessor :non_runnable_exit_status
+        attr_reader :languages
+        attr_reader :formatters
+        attr_reader :options
+        attr_reader :file_args
+        
+        def initialize(args)
+          @args = args.dup
+          @runnable = true
+          @non_runnable_exit_status = 0
+          @options = {
+            languages: [],
+            requires: [],
+            formats: [],
+            outputs: [],
+          }
+          @file_args = []
+          
+          @parser = make_parser
+
+          parse_args
+          validate_file_args if runnable?
+          load_requires if runnable?
+          validate_languages if runnable?
+          validate_formats if runnable?
+          list_languages if runnable? && @options[:list_languages]
+          list_formats if runnable? && @options[:list_formats]
+
+        end
+
+        # rubocop: disable Style/TrivialAccessors
+        def runnable?
+          @runnable
+        end
+        # rubocop: enable Style/TrivialAccessors
+        
+        private
+        
+        # rubocop: disable MethodLength
+        def make_parser
+          ::OptionParser.new do |opts|
+            opts.banner = 'ci-syntax-tool [options] [path]'
+
+            opts.on('-V', '--version',
+                    'Show ci-syntax-tool version') do
+              @options[:version] = true
+            end
+
+            opts.on('-h', '--help',
+                    'Show this help message') do
+              @options[:help] = true
+            end
+
+            opts.on('-l', '--lang LANG',
+                    'Select this language for checking.  Repeatable.' \
+                    '  Default, all languages.') do |lang|
+              @options[:languages] << lang
+            end
+
+            opts.on('--list-languages',
+                    'List available languages and exit.') do
+              @options[:list_languages] = true
+            end
+
+            opts.on('-d', '--debug',
+                    'Provide debug-level output to STDOUT.') do
+              @options[:debug] = true
+            end
+
+            opts.on('-r', '--require RUBYFILE',
+                    'Load additional Ruby code, perhaps for a custom ' \
+                    'language or format.  Repeatable.') do |r|
+              @options[:requires] << r
+            end
+
+            opts.on('-f', '--format FORMAT',
+                    'Use this format for output.  Repeatable, but if ' \
+                    'repeated, must have an equal number of --output ' \
+                    'options.') do |fmt|
+              @options[:formats] << fmt
+            end
+
+            opts.on('-o', '--output PATH',
+                    'Write formatted output to this location.  Use "-" '\
+                    'to represent STDOUT.  Defaults to STDOUT if zero or ' \
+                    'one --format option used.  Repeatable with an equal ' \
+                    'number of --format options.') do |path|
+              @options[:outputs] << path
+            end
+
+            opts.on('--list-formats',
+                    'List available formats and exit.') do
+              @options[:list_formats] = true
+            end
+
+          end
+        end
+        # rubocop: enable MethodLength
+
+        def parse_args
+          if @args.include?('-V') || @args.include?('--version')
+            # Handle version case, which otherwise is eaten by optionparser
+            @runnable = false
+            @non_runnable_exit_status = 0
+            puts 'ci-syntax-tool ' + CI::Syntax::Tool::VERSION
+
+          elsif @args.include?('-h') || @args.include?('--help')
+            # Handle help case, which otherwise is eaten by optionparser
+            @runnable = false
+            @non_runnable_exit_status = 0
+            puts @parser.help
+          else
+            begin
+              @parser.parse!(@args)
+              @file_args = @args
+            rescue OptionParser::InvalidOption => e
+              e.recover @args
+            end
+          end
+        end
+
+        def list_languages
+          LanguageFactory.all_language_names.sort.each do |lang_name|
+            puts lang_name
+          end
+          @runnable = false
+        end
+
+        def list_formats
+          FormatFactory.all_format_names.sort.each do |fmt_name|
+            puts fmt_name
+          end
+          @runnable = false
+        end
+
+        def validate_languages
+          @options[:languages].each do |lang_opt|
+            next if LanguageFactory.valid_language?(lang_opt)
+            
+            $stderr.puts "'#{lang_opt}' is not a valid language"
+            @runnable = false
+            @non_runnable_exit_status = 3
+            break
+          end
+
+          # If no languages were specified, do all languages
+          @options[:languages] = LanguageFactory.all_language_names if @options[:languages].empty?
+        end
+
+        def validate_file_args
+          # TODO: need feature tests on this
+          file_args.each do |path|
+            next if File.exist?(path)
+            $stderr.puts "'#{path}' does not exist"
+            @runnable = false
+            @non_runnable_exit_status = 6
+            break
+          end
+          file_args << '.' if file_args.empty?
+        end
+          
+        def validate_formats
+          
+          # If there are zero formats, assume 'Progress'
+          @options[:formats] << 'Progress' if @options[:formats].empty?
+          
+          @options[:formats].each do |lang_opt|
+            next if FormatFactory.valid_format?(lang_opt)
+            
+            $stderr.puts "'#{lang_opt}' is not a valid format"
+            @runnable = false
+            @non_runnable_exit_status = 4
+            return
+          end
+
+          # If there are zero outputs, assume '-'
+          @options[:outputs] << '-' if @options[:outputs].empty?
+          
+          # Insist that the number of outputs
+          # match the number of formats
+          unless @options[:outputs].length == @options[:formats].length
+            $stderr.puts "Must have exactly the same number of outputs as formats."
+            @runnable = false
+            @non_runnable_exit_status = 4
+          end
+          
+        end
+
+        def load_requires
+          @options[:requires].each do |require_path|
+
+            if File.exist?(require_path)
+              begin
+                Kernel.require(require_path)
+              rescue Exception => e 
+                if options[:debug]
+                  $stderr.puts e.class.name
+                  $stderr.puts e.to_s
+                  $stderr.puts e.backtrace.join("\n")
+                end
+                $stderr.puts "Could not load #{require_path} because it appears to be invalid."
+                @runnable = false
+                @non_runnable_exit_status = 5                
+                break
+              end
+            else
+              $stderr.puts "Could not load #{require_path} because it appears to be missing."
+              @runnable = false
+              @non_runnable_exit_status = 5
+              break
+            end
+          end
+        end
+        
+      end
+    end
+  end
+end