puppet_pot_generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1f9d8c46edba4a59cfef9ea41c6671d3b1b8c23
+  data.tar.gz: bf41e23223f77825d16251766d45eba21ae14305
+SHA512:
+  metadata.gz: f521071f9b9a0cdb44adf90bdc57f43b6962b7d4f71edd9683527fd1e429e03fa5cb436c27d44038b7b2f7031e03426af015b5beb6b37a7b757fcabb620836a1
+  data.tar.gz: 5563fa842f7285cc500ae379f783162e1236278f0a12f8781be1c7027d106add3137fd144e4ad398ce1379b3455a3d8b0ad058d293b3d8cae626585402bd5ddb

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,22 @@
+# puppet_pot_generator
+Library / Gem to generate a gettext style pot file from puppet code.
+
+## Usage
+
+Add this to your Gemfile.
+
+```shell
+gem "puppet_pot_generator", :git => 'git@github.com:puppetlabs/puppet_pot_generator.git'
+```
+
+Add this to your Rakefile.
+
+```shell
+require 'puppet_pot_generator/rake_tasks'
+```
+
+And to run the generation.
+
+```shell
+rake generate_puppet_pot
+```

data/lib/puppet_pot_generator.rb

@@ -0,0 +1,77 @@
+require 'puppet'
+
+# Parses and reports every instance of a translate function
+class PuppetPotGenerator
+  attr_reader :metrics
+  TRANSLATE_FUNCTION = 'translate'.freeze
+  PATH_TO_MANIFESTS = './manifests/**/*.pp'.freeze
+  PATH_TO_LOCALES = './locales'.freeze
+  PUPPET_POT_FILE = File.join(PATH_TO_LOCALES, 'puppet.pot')
+
+  def self.generate_puppet_pot_file
+    raise "PuppetPotGenerator: #{PATH_TO_LOCALES} folder does not exist" unless File.directory?(PATH_TO_LOCALES)
+    raise 'PuppetPotGenerator: requires version 5 of greater of puppet' unless Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0
+    parser = Puppet::Pops::Parser::EvaluatingParser.new
+    ppg = PuppetPotGenerator.new
+    open(PUPPET_POT_FILE, 'w') { |file| file << ppg.header }
+    Dir[PATH_TO_MANIFESTS].each do |file|
+      program = parser.parse_file(file)
+      ppg.compute(program)
+    end
+  end
+
+  def initialize
+    @potgenerator_visitor ||= Puppet::Pops::Visitor.new(nil, 'potgenerator', 0, 0)
+  end
+
+  def compute(target)
+    @path = []
+    target._pcore_all_contents(@path) { |element| potgenerator(element) }
+  end
+
+  def header
+    <<-HEADER
+  #, fuzzy
+  msgid ""
+  msgstr ""
+  "Project-Id-Version: PACKAGE VERSION\\n"
+  "Report-Msgid-Bugs-To: \\n"
+  "POT-Creation-Date: #{Time.now}\\n"
+  "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\\n"
+  "Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n"
+  "Language-Team: LANGUAGE <LL@li.org>\\n"
+  "MIME-Version: 1.0\\n"
+  "Content-Type: text/plain; charset=UTF-8\\n"
+  "Content-Transfer-Encoding: 8bit\\n"
+  "X-Generator: Translate Toolkit 2.0.0\\n"
+
+  HEADER
+  end
+
+  def report_on_translate_function(statement)
+    return unless statement.functor_expr.class == Puppet::Pops::Model::QualifiedName && statement.functor_expr.value == TRANSLATE_FUNCTION
+    line_number = statement.arguments[0].locator.line_for_offset(statement.arguments[0].offset)
+    path_to_file = statement.arguments[0].file
+    string_to_be_translated = if defined?(statement.arguments[0].segments)
+                                statement.arguments[0].segments[0].value
+                              else
+                                statement.arguments[0].value
+                              end
+    pot_entry =  '#. ' + path_to_file + ':' + line_number.to_s + "\n"
+    pot_entry << 'msgid "' + string_to_be_translated + "\"\n"
+    pot_entry << "msgstr \"\"\n"
+    open(PUPPET_POT_FILE, 'a') do |file|
+      file << pot_entry
+    end
+  end
+
+  def potgenerator(o)
+    @potgenerator_visitor.visit_this_0(self, o)
+  end
+
+  def potgenerator_Object(o); end # rubocop:disable Style/MethodName
+
+  def potgenerator_CallExpression(o) # rubocop:disable Style/MethodName
+    report_on_translate_function(o)
+  end
+end

data/lib/puppet_pot_generator/rake_tasks.rb

@@ -0,0 +1,11 @@
+require 'puppet_pot_generator'
+
+desc 'Generate POT file for puppet code'
+task :generate_puppet_pot do
+  result = PuppetPotGenerator.generate_puppet_pot_file
+  if result
+  # puts "POT metadata file #{PuppetPotGenerator.puppet_pot_file_path} has been generated"
+  else
+    exit 1
+  end
+end

data/lib/puppet_pot_generator/version.rb

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

data/spec/puppet_pot_generator/puppet_pot_generator_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe 'puppet_pot_generator' do
+  let(:file) { PuppetPotGenerator::PUPPET_POT_FILE }
+  let(:content) { File.read(file) }
+
+  it 'testing complete' do
+    expect(true).to be true # rubocop:disable RSpec/ExpectActual
+  end
+
+  describe '#generate_puppet_pot_file' do
+    it 'is expected to not raise an error' do
+      expect { PuppetPotGenerator.generate_puppet_pot_file }.not_to raise_error
+    end
+
+    it 'is expected to append to the puppet POT file' do
+      expect(File.exist?(file)).to be true
+    end
+
+    it 'is expected to create a POT header' do
+      expect(content).to match %r{POT-Creation-Date}
+    end
+  end
+
+  describe '#report_on_translate_function' do
+    let(:parser) { Puppet::Pops::Parser::EvaluatingParser.new }
+
+    before :each do
+      File.open('puppet.pp', 'w') { |file| file.write "translate('Hello, world!')" }
+      statement = parser.parse_file('puppet.pp').body
+      PuppetPotGenerator.new.report_on_translate_function(statement)
+    end
+
+    after :each do
+      FileUtils.rm('puppet.pp')
+    end
+
+    it 'is expected to write file location to the puppet POT file' do
+      expect(content).to match %r{puppet.pp}
+    end
+
+    it 'is expected to write msgid to the puppet POT file' do
+      expect(content).to match %r{msgid "Hello, world!"}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'puppet_pot_generator'
+require 'puppet'
+require 'puppet/pops/parser/evaluating_parser'
+
+LOCALES_DIR = File.join(File.dirname(__FILE__), '../locales')
+
+def create_dirs(dirs)
+  puts "Creating directories: #{dirs}"
+  dirs.each { |dir| FileUtils.mkdir_p(dir) }
+end
+
+def destroy_dirs(dirs)
+  puts "Destroying directories: #{dirs}"
+  dirs.each { |dir| FileUtils.rm_rf(dir) if File.exist? dir }
+end
+
+RSpec.configure do |c|
+  c.before(:all) do # rubocop:disable RSpec/BeforeAfterAll
+    create_dirs([LOCALES_DIR])
+  end
+
+  c.after(:all) do # rubocop:disable RSpec/BeforeAfterAll
+    destroy_dirs([LOCALES_DIR])
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: puppet_pot_generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Puppet, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: semantic_puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    Generates a pot file from your puppet code\n"
+email:
+- info@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet_pot_generator.rb
+- lib/puppet_pot_generator/rake_tasks.rb
+- lib/puppet_pot_generator/version.rb
+- spec/puppet_pot_generator/puppet_pot_generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/puppetlabs/puppet-pot-generator
+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: Generates a pot file from your puppet code
+test_files:
+- spec/puppet_pot_generator/puppet_pot_generator_spec.rb
+- spec/spec_helper.rb