puppet-lint-i18n 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2e0fe51e23437c58356cbc5073e4ad4672dd269
+  data.tar.gz: ef36f41a22ec84b6d7093797d9a5b18274833c73
+SHA512:
+  metadata.gz: 5445274a478ccd27bf782206a944413632512ed92e2c69efc54cdc54dd39b7fa95a0ff4fe9c7f443949487ee3ab47274b16d51a01d6607abf0a721921f9e3218
+  data.tar.gz: 5d701f40d2707f58149394a35f9513946ce4ca03b93e1f2e7d45e85783364fb26386a6fd4f7b9d9d1f55698d07d56364a49c42ba3a9d13f8700a3ba8fd03497f

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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.md

@@ -0,0 +1,85 @@
+# puppet-lint-i18n plugin
+
+
+## Installation
+
+To use this plugin, add the following like to the Gemfile in your Puppet code base and run `bundle install`.
+
+```ruby
+gem 'puppet-lint-i18n'
+```
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`. It will detect functions that do not have their output message wrapped in a translate call.
+
+### Functions detected
+
++ warning
++ fail
+
+### Before and after
+
+For example the following puppet code does not wrap the message
+```puppet
+warning('message')
+```
+wrapping the message then looks like
+```puppet
+warning(translate('message'))
+```
+
+### Example output
+
+```
+WARNING: 'warning' messages should be decorated: eg translate('old_root_password is no longer used and will be removed in a future release') on line 48
+```
+This tells you which file and what line the infringement occurred, as well as the suggested fix
+
+### Other Infringements
+
++ Multiline strings
+
+**BAD**
+```puppet
+warning(translate('to be or') / 
+translate('not to be'))
+```
+
+**GOOD**
+```puppet
+warning(translate('to be or not to be')
+```
+
++ Concatenated strings
++ Heredoc strings
+
+The :HEREDOC_OPEN token (`@(EOL)`) should be the only part passed to the `translate()` function. Do not pass the entire heredoc.
+
+**BAD**
+```puppet
+warning(translate(@(EOL)
+  This is a heredoc.
+  It's lovely. 
+  | EOL))
+```
+
+**GOOD**
+```puppet
+warning(translate(@(EOL))
+  This is a heredoc.
+  It's lovely. 
+  | EOL)
+```
+
++ Interpolated strings
+
+_Interpolated strings are not supported at this time and will not be decorated with the fix option._
+
+### Fix issues automatically
+
+**--fix support: Yes**
+
+### Disabling checks
+
+Please refer to the documentation here [https://github.com/rodjek/puppet-lint#disable-lint-checks]

data/lib/puppet-lint/plugins/check_i18n.rb

@@ -0,0 +1,63 @@
+PuppetLint.new_check(:check_i18n) do
+  TRANSLATE_FUNCTION = 'translate'.freeze
+  STRINGY = Set[:STRING, :SSTRING, :DQPRE]
+  FUNCTIONS_TO_BE_DECORATED = Set['warning', 'fail']
+  def check
+    tokens.select { |token| FUNCTIONS_TO_BE_DECORATED.include?(token.value) && function?(token) && message_not_decorated?(token) }.each do |token|
+      function = token.value
+      non_decorated_message = token.next_token.next_token
+
+      interpolation = interpolation? non_decorated_message
+      heredoc = heredoc? non_decorated_message
+
+      message = if interpolation
+                  "#{function}(#{non_decorated_message.value}) should be decorated but interpolation is not supported at this time."
+                elsif heredoc
+                  "'#{function}' messages should be decorated: eg #{TRANSLATE_FUNCTION}(#{non_decorated_message.value}) heredoc detected."
+                else
+                  "'#{function}' messages should be decorated: eg #{TRANSLATE_FUNCTION}(#{non_decorated_message.value})"
+                end
+
+      notify :warning, message: message,
+                       line: token.line,
+                       column: non_decorated_message.column,
+                       token: non_decorated_message,
+                       interpolation: interpolation,
+                       heredoc: heredoc
+    end
+  end
+
+  def fix(problem)
+    return if problem[:interpolation]
+
+    left_index = tokens.index(problem[:token])
+    right_index = if problem[:heredoc]
+                    tokens.index(problem[:token].find_token_of(:next, :NEWLINE, skip_blocks: true) || problem[:token].find_token_of(:next, :WHITESPACE, skip_blocks: true))
+                  else
+                    tokens.index(problem[:token].find_token_of(:next, :RPAREN, skip_blocks: true))
+                  end
+
+    # order of insertion is important, we insert right to left, so as not to muddy the indexing
+    tokens.insert(right_index, PuppetLint::Lexer::Token.new(:RPAREN, ')', 0, 0))
+    tokens.insert(left_index, PuppetLint::Lexer::Token.new(:NAME, TRANSLATE_FUNCTION, 0, 0))
+    tokens.insert((left_index + 1), PuppetLint::Lexer::Token.new(:LPAREN, '(', 0, 0))
+  end
+
+  def function?(suspected_function)
+    suspected_function.type == :FUNCTION_NAME || suspected_function.type == :NAME
+  end
+
+  def message_not_decorated?(token)
+    # the next token is the openning round brace so grab the next
+    suspected_i18n_function = token.next_token.next_token
+    suspected_i18n_function.value != TRANSLATE_FUNCTION
+  end
+
+  def interpolation?(token)
+    token.type == :DQPRE
+  end
+
+  def heredoc?(token)
+    token.type == :HEREDOC_OPEN
+  end
+end

data/lib/puppet-lint/plugins/version.rb

@@ -0,0 +1,4 @@
+# version of this gem
+class CheckI18n
+  VERSION ||= '1.0.0'.freeze
+end

data/spec/puppet-lint/plugins/check_i18n_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe 'check_i18n' do
+  let(:msg) { "'warning' messages should be decorated: eg translate(message)" }
+  let(:int_msg) { %r{interpolation is not supported} }
+  let(:here_msg) { %r{heredoc detected} }
+
+  context 'with fix disabled' do
+    context 'function without translate function' do
+      let(:code) { "warning('message')" }
+
+      it 'detects a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'creates a warning' do
+        expect(problems).to contain_warning(msg).on_line(1).in_column(9)
+      end
+    end
+
+    context 'with ${} interpolation' do
+      let(:code) { 'warning("a message: ${message}")' }
+
+      it 'detects a problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'creates warning' do
+        expect(problems[0][:message]).to match(int_msg)
+      end
+
+      it 'expects problem[:interpolation] to be true' do
+        expect(problems[0][:interpolation]).to be_truthy
+      end
+    end
+
+    context 'with $ interpolation' do
+      let(:code) { 'warning("a message: $message")' }
+
+      it 'detects a problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'creates warning' do
+        expect(problems[0][:message]).to match(int_msg)
+      end
+
+      it 'expects problem[:interpolation] to be true' do
+        expect(problems[0][:interpolation]).to be_truthy
+      end
+    end
+
+    context 'with a heredoc' do
+      let(:code) do
+        'warning(@(EOL)
+       this is a heredoc
+       | EOL)'
+      end
+
+      it 'detects something' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'creates warning' do
+        expect(problems[0][:message]).to match(here_msg)
+      end
+
+      it 'expects problem[:heredoc] to be true' do
+        expect(problems[0][:heredoc]).to be_truthy
+      end
+    end
+
+    context 'function with translate function' do
+      let(:code) { "warning(translate('message'))" }
+
+      it 'does not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before(:each) do
+      PuppetLint.configuration.fix = true
+    end
+
+    after(:each) do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'function without a translate function' do
+      let(:code) { "warning('message')" }
+
+      it 'onlies detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'fixes the problem' do
+        expect(problems).to contain_fixed(msg).on_line(1).in_column(9)
+      end
+
+      it 'adds a newline to the end of the manifest' do
+        expect(manifest).to eq("warning(translate('message'))")
+      end
+    end
+
+    context 'function without a translate function with interpolation' do
+      let(:code) { 'warning("a message: ${message}")' }
+
+      it 'onlies detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'adds a newline to the end of the manifest' do
+        expect(manifest).not_to eq("warning(translate('message'))")
+      end
+    end
+
+    context 'function without a translate function with a heredoc' do
+      let(:code) do
+        'warning(@(EOL)
+       heredoc
+       | EOL)'
+      end
+
+      it 'onlies detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'decorates the heredoc appropriately' do
+        expect(manifest).to match(%r{warning\(translate\(@\(EOL\)\)})
+      end
+    end
+
+    context 'function with translate function' do
+      let(:code) { "warning(translate('message'))" }
+
+      it 'does not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'does not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-i18n
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Puppet, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Will check the decoration of your puppet code
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_i18n.rb
+- lib/puppet-lint/plugins/version.rb
+- spec/puppet-lint/plugins/check_i18n_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/puppetlabs/puppet-lint-i18n
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Will check the decoration of your puppet code
+test_files:
+- spec/puppet-lint/plugins/check_i18n_spec.rb
+- spec/spec_helper.rb