ci-syntax-tool 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12e0cbc5efe12dc146a5ede4094ea62f0137915d
-  data.tar.gz: 480b4eff820df5aac1ad736330918492f5a9324b
+  metadata.gz: 48c6b5c42852bbebba0adf68bac910ef045c904a
+  data.tar.gz: 71fe5ab362375d55db9a71229e4d25c9d580a04a
 SHA512:
-  metadata.gz: c77c377d030d48e67134ef124633a1d2307288cbe0f6f00cc5fdc9bd4636c966b530ad65bf2971b0ba2cdac55d055f9ec32da99c193fb661cf59fc2aed49b555
-  data.tar.gz: 55f16c7324455770784844f16243c2038b2371e1cd1a95602658c3d122c815204458bd6507d2d0944850b91f3bcba8ef52fecee80009cf99a28baf4303eda837
+  metadata.gz: b25922cd44c509c9df3104439b67b783a907a7cfcbbf3c50523f0de06c137576e91bf89fe8784e409b2fbfe32d7dfc21d43025cdf2efa1d37cd9e7d52f4c124d
+  data.tar.gz: f1a026f1c4fe68acc04c2663acb75d7581cf82a01dbf955fab681f494321f854d1eaf5de0f54da8725fa6ebeb0c21214bfeba08a1f9dfd80f93300e1d91ed399

data/README.md

@@ -64,6 +64,24 @@ This might be good enough for a commit hook.
 
 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.
 
+## Rake Support
+
+The gem includes a Rake Task, which you can use in your rakefiles.
+
+    require 'ci-syntax-tool/rake_task'
+
+    # Gives you a 'syntax' task, just like running CLI with defaults:
+    # all languages, Progress format to STDOUT
+    CI::Syntax::Tool::RakeTask.new()
+
+    # Bells and whistles - I like this for CI
+    CI::Syntax::Tool::RakeTask.new('myname') do |taskdef|
+      taskdef.formats = [ 'Progress', 'JUnit' ]
+      taskdef.outputs = [ '-', 'test/reports/syntax.xml' ]
+      taskdef.languages = [ 'YAML', 'Ruby' ] # Default all - only specify to restrict
+      taskdef.options = [ '--anything', '--else']
+    end
+
 ## Language Syntax Plugins
 
 So far, we support:

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

@@ -0,0 +1,74 @@
+
+require 'rake'
+require 'rake/tasklib'
+
+module CI
+  module Syntax
+    module Tool
+      
+      # Provides a custom rake task.
+      #
+      # require 'ci-syntax-tool/rake_task'
+      # CI::Syntax::Tool::RakeTask.new
+      class RakeTask < Rake::TaskLib
+        attr_accessor :name
+        attr_accessor :fail_on_error
+        attr_accessor :verbose
+        attr_accessor :languages
+        attr_accessor :outputs
+        attr_accessor :formats
+        attr_accessor :options
+
+        def initialize(*args, &task_block)
+          setup_ivars(args)
+
+          desc 'Run syntax checks' unless ::Rake.application.last_comment
+
+          task(name, *args) do |_, task_args|
+            RakeFileUtils.send(:verbose, verbose) do
+              if task_block
+                task_block.call(*[self, task_args].slice(0, task_block.arity))
+              end
+              run_main_task(verbose)
+            end
+          end
+        end
+
+        def run_main_task(verbose)
+          run_cli(verbose, full_options)
+        end
+
+        private
+
+        def run_cli(verbose, options)
+          require 'ci-syntax-tool'
+
+          cli_opts = CommandLine.new(options)
+          puts 'Running ci-syntax-tool...' if verbose
+          result = Checker.new(cli_opts).run
+          abort('Syntax checks failed!') if result != 0 && fail_on_error
+        end
+
+        def full_options
+          [].tap do |result|
+            result.concat(formats.map { |f| ['--format', f] }.flatten)
+            result.concat(outputs.map { |o| ['--output', o] }.flatten)
+            result.concat(languages.map { |l| ['--output', l] }.flatten)
+            result.concat(options)
+          end
+        end
+        
+        def setup_ivars(args)
+          @name = args.shift || :syntax
+          @verbose = true
+          @fail_on_error = true
+          @languages = []
+          @formats = []
+          @options = []
+          @outputs = []
+        end
+        
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module CI
     #   Simple container for namespacing the project.  Here, just the
     # version string.
     module Tool
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
     end
   end
 end

data/test/fixtures/rakefiles/Rakefile

@@ -0,0 +1,16 @@
+require 'ci-syntax-tool/rake_task'
+
+# All defaults - should be 'syntax'
+CI::Syntax::Tool::RakeTask.new
+
+
+CI::Syntax::Tool::RakeTask.new('renamed')
+
+desc 'Alt description'
+CI::Syntax::Tool::RakeTask.new('altdesc')
+
+CI::Syntax::Tool::RakeTask.new('prog-junit') do |t|
+  t.formats = [ 'Progress', 'JUnit' ]
+  t.outputs = [ '-', 'test/tmp/rake-out-1.out' ]
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ci-syntax-tool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Clinton Wolfe
@@ -105,6 +105,7 @@ files:
 - lib/ci-syntax-tool/language/base.rb
 - lib/ci-syntax-tool/language/yaml.rb
 - lib/ci-syntax-tool/language_factory.rb
+- lib/ci-syntax-tool/rake_task.rb
 - lib/ci-syntax-tool/result.rb
 - lib/ci-syntax-tool/version.rb
 - rubocop.yml
@@ -130,6 +131,7 @@ files:
 - test/fixtures/files/error/missing-array-element.yaml
 - test/fixtures/files/error/unquoted-jinja-template.yaml
 - test/fixtures/files/error/very-high-yaml-version.yaml
+- test/fixtures/rakefiles/Rakefile
 - test/fixtures/require/invalid.rb
 - test/fixtures/require/mock_format.rb
 - test/fixtures/require/second.rb
@@ -188,6 +190,7 @@ test_files:
 - test/fixtures/files/error/missing-array-element.yaml
 - test/fixtures/files/error/unquoted-jinja-template.yaml
 - test/fixtures/files/error/very-high-yaml-version.yaml
+- test/fixtures/rakefiles/Rakefile
 - test/fixtures/require/invalid.rb
 - test/fixtures/require/mock_format.rb
 - test/fixtures/require/second.rb