puppet-syntax 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6606744a1866c599818bf66f5049dd0fdafeaa68
-  data.tar.gz: 353c86d96ce6356fa46fddcbb66eb8429ee81a3a
+  metadata.gz: 8f3a393428ed2fa0c2d2bfcf1f540d80589d5d16
+  data.tar.gz: 8a40d90b8a844849051064d8d3042bd568da95a0
 SHA512:
-  metadata.gz: 3ea3d4e1c1f63a3f7f92dcd1d99e3401004c3e6eec01036d2227f0127b45d01a7790f58f9147b4f9d172649aa4264aed100da2e9a822179f5b68b6363616de85
-  data.tar.gz: e50e01a78dcf9b35ee36be7866e1328ab39df08dbab5d45f45a7bdcd4ef06e9ffdc5149df7227dbf92f8e461be9b92f23c84d231b07e410a20ac401963259a0e
+  metadata.gz: 37e9b85d01f0ec31b29a6ecbbe264f3e6d714af42d83b1d7f08db735fbd7b09b058e516d639b976a4a6e6a097f7c87db82beeb4ee52a529f672599549284a45f
+  data.tar.gz: 1786cccadd25ace8e001fdaa4bf4a0b0966ed90726709595f7a291020726754992857261b2f46fdee1032f9cb6c65f514e8d24ca5433891b9ed1234781fed997

data/.travis.yml

@@ -2,6 +2,7 @@
 language: ruby
 # Workaround https://github.com/bundler/bundler/issues/3558
 before_install: gem install bundler
+install: bundle install --jobs 4 --retry 2 --without development
 script: bundle exec rake
 rvm:
   - 1.9.3

data/CHANGELOG

@@ -1,3 +1,7 @@
+2017-06-29 Release 2.4.1
+- Fix to ensure namespace scope is inherited.
+- Cleanly exits when syntax warnings/errors are found instead of failing.
+
 2017-03-14 Release 2.4.0
 - Add check_hiera_keys flag for deep checking of Hiera key name correctness. Thanks @petems.
 - Fix Puppet version comparisons for compatibility with Puppet 4.10.

data/Gemfile

@@ -22,3 +22,7 @@ gem 'puppet', *location_for(ENV['PUPPET_VERSION'] || '>2.7.0')
 
 # older version required for ruby 1.9 compat, as it is pulled in as dependency of puppet, this has to be carried by the module
 gem 'json_pure', '<= 2.0.1'
+
+group :test do
+  gem 'rspec'
+end

data/README.md

@@ -2,136 +2,138 @@
 
 # Puppet::Syntax
 
-Syntax checks for Puppet manifests, templates, and Hiera YAML.
+Puppet::Syntax checks for correct syntax in Puppet manifests, templates, and Hiera YAML.
 
 ## Version support
 
-This should work on any version of:
+Puppet::Syntax is supported with:
 
 - Puppet >= 2.7 that provides the `validate` face.
-- Ruby >= 1.8 with `erb` from stdlib.
+- Ruby >= 1.8 with `erb` from Ruby stdlib.
 
-You can see the matrix of specific versions that we currently test against
-in the [TravisCI config](.travis.yml).
+For the specific versions that we test against, see the [TravisCI config](.travis.yml).
 
-If you're using `puppetlabs_spec_helper/rake_tasks` and getting unexpected
-non-zero exit codes then you should upgrade to [puppetlabs_spec_helper][psh]
-\>= 0.8.0 which no longer has a conflicting rake task and now depends on
-this project.
+If you're using `puppetlabs_spec_helper/rake_tasks` and getting unexpected non-zero exit codes, upgrade to [puppetlabs_spec_helper][psh] version 0.8.0 or greater. Versions of `puppetlabs_spec_helper` prior to 0.8.0 conflicted with Puppet::Syntax.
 
 [psh]: https://github.com/puppetlabs/puppetlabs_spec_helper
 
-## Usage
+## Installation
 
-Include the following in your `Rakefile`:
+To install Puppet::Syntax, either add it to your module's Gemfile or install the gem manually.
 
-    require 'puppet-syntax/tasks/puppet-syntax'
+* To install with the Gemfile, add:
 
-Test all manifests and templates relative to your `Rakefile`:
+        gem 'puppet-syntax'
 
-    ➜  puppet git:(master) bundle exec rake syntax
-    ---> syntax:manifests
-    ---> syntax:templates
-    ---> syntax:hiera:yaml
+  And then execute:
 
-A non-zero exit code and error message will be returned for any failures:
+        $ bundle install
 
-    ➜  puppet git:(master) bundle exec rake syntax
-    ---> syntax:manifests
-    rake aborted!
-    Could not parse for environment production: Syntax error at end of file at demo.pp:2
-    Tasks: TOP => syntax => syntax:manifests
-    (See full trace by running task with --trace)
+* To install the gem yourself, run:
 
-Use in conjunction with lint and spec tests for Continuous Integration:
+        $ gem install puppet-syntax
 
-    task :test => [
-      :syntax,
-      :lint,
-      :spec,
-    ]
+## Configuration
 
-## Checks
+To configure Puppet::Syntax, add any of the following settings to your `Rakefile`.
 
-### hiera
+* To exclude certain paths from the syntax checks, set:
 
-Checks `.yaml` files for syntax errors.
+        PuppetSyntax.exclude_paths = ["vendor/**/*"]
 
-By default, the rake task will look for all `.yaml` files under:
+* To use the Puppet 4 ("future") parser in Puppet 3.2 through 3.8, set:
 
-* `**/data/**/*.yaml`
-* `hieradata/**/*.yaml`
-* `hiera*.yaml`
+        PuppetSyntax.future_parser = true
 
-### manifests
+* To configure specific paths for the Hiera syntax check, specify `hieradata_paths`. This is useful if you use Hiera data inside your module.
 
-Checks `.pp` files for syntax errors
+        PuppetSyntax.hieradata_paths = ["**/data/**/*.yaml", "hieradata/**/*.yaml", "hiera*.yaml"]
 
-### templates
+* To validate the syntax of code written for application orchestration, enable `app_management`:
 
-#### erb
+        PuppetSyntax.app_management = true
 
-Checks `.erb` files for syntax errors
+  The `app_management` setting is supported with Puppet 4.3 or greater and is off by default. In Puppet 5, app_management is always enabled.
 
-#### epp
+* To ignore deprecation warnings, disable `fail_on_deprecation_notices`. By default, `puppet-syntax` fails if it encounters Puppet deprecation notices. If you are working with a legacy code base and want to ignore such non-fatal warnings, you might want to override the default behavior.
 
-Checks `.epp` files for syntax errors.
+        PuppetSyntax.fail_on_deprecation_notices = false
 
-Note: This will only occur when Puppet version specified is Puppet 4+ or Puppet 3 with the future parser enabled
+* To enable a syntax check on Hiera keys, set:
 
-## Configuration
+        PuppetSyntax.check_hiera_keys = true
 
-Paths can be excluded with:
+   This reports common mistakes in key names in Hiera files, such as:
 
-    PuppetSyntax.exclude_paths = ["vendor/**/*"]
+  - Leading `::` in keys, such as: `::notsotypical::warning2: true`.
+  - Single colon scope separators, such as: `:picky::warning5: true`.
+  - Invalid camel casing, such as: `noCamelCase::warning3: true`.
+  - Use of hyphens, such as: `no-hyphens::warning4: true`.
 
-When you are using a Puppet version greater then 3.2, you can select the future parse by specifying
+## Usage
 
-    PuppetSyntax.future_parser = true
+* To enable Puppet::Syntax, include the following in your module's `Rakefile`:
 
-If you are using some form of hiera data inside your module, you can configure where the `syntax:hiera:yaml` task looks for data with:
+        require 'puppet-syntax/tasks/puppet-syntax'
 
-    PuppetSyntax.hieradata_paths = ["**/data/**/*.yaml", "hieradata/**/*.yaml", "hiera*.yaml"]
+  For Continuous Integration, use Puppet::Syntax in conjunction with `puppet-lint` and spec tests. Add the following to your module's `Rakefile`:
 
-If you are trying to validate the syntax of code written for application orchestration, you can enable the `app_management` setting:
+        task :test => [
+          :syntax,
+          :lint,
+          :spec,
+        ]
 
-    PuppetSyntax.app_management = true
+* To test all manifests and templates, relative to the location of the `Rakefile`, run:
 
-`app_management` is supported on Puppet 4.3 or higher, defaulting to off. On Puppet 5, it is always enabled.
+        $ bundle exec rake syntax
+        ---> syntax:manifests
+        ---> syntax:templates
+        ---> syntax:hiera:yaml
 
-Deprecation notices will cause a failure by default, you can override this functionality by setting:
+* To return a non-zero exit code and an error message on any failures, run:
 
-    PuppetSyntax.fail_on_deprecation_notices = false
+        $ bundle exec rake syntax
+        ---> syntax:manifests
+        rake aborted!
+        Could not parse for environment production: Syntax error at end of file at demo.pp:2
+        Tasks: TOP => syntax => syntax:manifests
+        (See full trace by running task with --trace)
 
-Common mistakes in key names in Hiera files will be reported:
+## Checks
 
-- Leading :: in keys eg. `::notsotypical::warning2: true`
-- Single colon scope seperators eg. `:picky::warning5: true`
-- Invalid camel casing eg. `noCamelCase::warning3: true`
-- Use of hyphens eg. `no-hyphens::warning4: true`
+Puppet::Syntax makes the following checks in the directories and subdirectories of the module, relative to the location of the `Rakefile`.
 
-This can be enabled by setting
+### Hiera
 
-    PuppetSyntax.check_hiera_keys = true
+Checks `.yaml` files for syntax errors.
 
-## Installation
+By default, this rake task looks for all `.yaml` files in a single module under:
 
-Add this line to your application's Gemfile:
+* `**/data/**/*.yaml`
+* `hieradata/**/*.yaml`
+* `hiera*.yaml`
 
-    gem 'puppet-syntax'
+### manifests
 
-And then execute:
+Checks all `.pp` files in the module for syntax errors.
 
-    $ bundle
+### templates
+
+#### erb
+
+Checks `.erb` files in the module for syntax errors.
+
+#### epp
 
-Or install it yourself as:
+Checks `.epp` files in the module for syntax errors.
 
-    $ gem install puppet-syntax
+EPP checks are supported in Puppet 4 or greater, or in Puppet 3 with the future parser enabled.
 
 ## Contributing
 
-1. Fork it
-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
+1. Fork the repo.
+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.

data/appveyor.yml

@@ -0,0 +1,38 @@
+build: off
+
+branches:
+  only:
+    - master
+
+# ruby versions under test
+environment:
+  matrix:
+    - RUBY_VERSION: 21
+      PUPPET_VERSION: "~> 3.8.7"
+    - RUBY_VERSION: 21
+      PUPPET_VERSION: "~> 4.8.0"
+    - RUBY_VERSION: 23-x64
+      PUPPET_VERSION: "~> 4.9.0"
+    - RUBY_VERSION: 23-x64
+      PUPPET_VERSION: "> 0"
+    - RUBY_VERSION: 23-x64
+      PUPPET_VERSION: "git://github.com/puppetlabs/puppet.git#master"
+
+matrix:
+  allow_failures:
+    - RUBY_VERSION: 23-x64
+      PUPPET_VERSION: "git://github.com/puppetlabs/puppet.git#master"
+      
+install:
+  - SET PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - SET LOG_SPEC_ORDER=true
+  - bundle install --jobs 4 --retry 2 --without development
+
+before_test:
+  - type Gemfile.lock
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake spec

data/lib/puppet-syntax/tasks/puppet-syntax.rb

@@ -33,7 +33,7 @@ module PuppetSyntax
 
       namespace :syntax do
         task :check_puppetlabs_spec_helper do
-          psh_present = Rake::Task[:syntax].actions.any? { |a|
+          psh_present = task(:syntax).actions.any? { |a|
             a.inspect.match(/puppetlabs_spec_helper\/rake_tasks\.rb:\d+/)
           }
 
@@ -65,8 +65,8 @@ version is less then 4.3.  The `app_management` setting will be ignored.
 
           c = PuppetSyntax::Manifests.new
           output, has_errors = c.check(filelist_manifests)
-          print "#{output.join("\n")}\n" unless output.empty?
-          fail if has_errors || ( output.any? && PuppetSyntax.fail_on_deprecation_notices )
+          $stdout.puts "#{output.join("\n")}\n" unless output.empty?
+          exit 1 if has_errors || ( output.any? && PuppetSyntax.fail_on_deprecation_notices )
         end
 
         desc 'Syntax check Puppet templates'
@@ -75,7 +75,8 @@ version is less then 4.3.  The `app_management` setting will be ignored.
 
           c = PuppetSyntax::Templates.new
           errors = c.check(filelist_templates)
-          fail errors.join("\n") unless errors.empty?
+          $stdout.puts "#{errors.join("\n")}\n" unless errors.empty?
+          exit 1 unless errors.empty?
         end
 
         desc 'Syntax check Hiera config files'
@@ -88,7 +89,8 @@ version is less then 4.3.  The `app_management` setting will be ignored.
             $stderr.puts "---> #{t.name}"
             c = PuppetSyntax::Hiera.new
             errors = c.check(filelist_hiera_yaml)
-            fail errors.join("\n") unless errors.empty?
+            $stdout.puts "#{errors.join("\n")}\n" unless errors.empty?
+            exit 1 unless errors.empty?
           end
         end
       end

data/lib/puppet-syntax/version.rb

@@ -1,3 +1,3 @@
 module PuppetSyntax
-  VERSION = "2.4.0"
+  VERSION = "2.4.1"
 end

data/puppet-syntax.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rake"
 
-  spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rb-readline"
   spec.add_development_dependency "gem_publisher", "~> 1.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +80,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- appveyor.yml
 - jenkins.sh
 - lib/puppet-syntax.rb
 - lib/puppet-syntax/hiera.rb
@@ -155,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Syntax checks for Puppet manifests, templates, and Hiera YAML