puppet-debugger 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d8a6792ac8befb2af4d9769af6b2ef803ae018c
-  data.tar.gz: d23e13a008ddf75f72883db3e79bab7e6cfb8ef8
+  metadata.gz: 1bbafde4d18168b16c4cfb22306b2d793e8e10b6
+  data.tar.gz: b3f50cb0d41f2286dfd71dd7837781a04ea693ff
 SHA512:
-  metadata.gz: cd3c1d7e97f909563ea3d1fa6f08ff836e8fc16732fd151b6f1ab80fce6fd96c1a9199bcc936cb58302340b40c2dd991aa97b60ff06c0729c0a76067bd00dd94
-  data.tar.gz: 1006a7f6453775c5d6b8ed307224fad0236c389bd404c475a9d24b4404153652676504d5c315132306888032f3b98ad138b50e3da296c040fd11c4dfb663501b
+  metadata.gz: 8b6b9337d3d11a98c03a4ead272bd6f9918d7d5a2a7d8b16b9f82ed337c7eb33eb4366646865e565f7aa8bf7ed9c66f5e30884a70a3aa3313cf30fcfd3048b4d
+  data.tar.gz: 4c6fafdbfafd13f1d0260c59bc3def51265969c22fee32a651fb7a6fcd2a0d25bd42fe55fff87db886c43db1cdaf8421f8105ffc9a9e52a67e18ba3621992c4b

data/.gitlab-ci.yml

@@ -44,7 +44,7 @@ bump_and_tag:
   only:
     - master@puppet-debugger/puppet-debugger
   script:
-    - gem install release_me 
+    - gem install release_me
     - bump_and_tag
 
 #web_trigger_production:
@@ -61,10 +61,10 @@ bump_and_tag:
 .ruby_22: &ruby22
   image: ruby:2.2
   script:
-  - gem install bundler -v 1.17.3 > /dev/null
-  - bundle install --without development validate
-  - bundle exec puppet module install puppetlabs-stdlib
-  - bundle exec rake spec
+    - gem install bundler -v 1.17.3 > /dev/null
+    - bundle install --without development validate
+    - bundle exec puppet module install puppetlabs-stdlib
+    - bundle exec rake spec
 
 .ruby_23: &ruby23
   image: ruby:2.3
@@ -75,7 +75,6 @@ bump_and_tag:
 .ruby_25: &ruby25
   image: ruby:2.5
 
-
 .ruby_26: &ruby26
   image: ruby:2.6
 
@@ -91,33 +90,9 @@ gem_production:
   only:
     - tags
 
-puppet_43_ruby22:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.3.0"
-  <<: *puppet_job_def
-  <<: *ruby22
-
-puppet_44_ruby22:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.4.0"
-  <<: *puppet_job_def
-  <<: *ruby22
-
-puppet_46_ruby22:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.6.0"
-  <<: *puppet_job_def
-  <<: *ruby22
-
-puppet_47_ruby22:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.7.0"
-  <<: *puppet_job_def
-  <<: *ruby22
-
 puppet_410_ruby24:
   variables:
-    PUPPET_GEM_VERSION: "~> 4.10.0"
+    PUPPET_GEM_VERSION: "~> 4.10"
   <<: *puppet_job_def
   <<: *ruby24
 
@@ -127,13 +102,13 @@ puppet_55_ruby24:
   <<: *puppet_job_def
   <<: *ruby24
 
-puppet_60_ruby25:
+puppet_63_ruby25:
   variables:
     PUPPET_GEM_VERSION: "~> 6.0"
   <<: *puppet_job_def
   <<: *ruby25
 
-puppet_60_ruby26:
+puppet_64_ruby26:
   variables:
     PUPPET_GEM_VERSION: "~> 6.4"
   <<: *puppet_job_def

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 0.12.2
+
+- Fixes incorrect puppet namespace when list functions
+
 ## 0.12.1
 
 - Fixes issue with command completion

data/lib/plugins/puppet-debugger/input_responders/functions.rb

@@ -1,30 +1,30 @@
-require 'puppet-debugger/input_responder_plugin'
-require 'table_print'
+require "puppet-debugger/input_responder_plugin"
+require "table_print"
 
 module PuppetDebugger
   module InputResponders
     class Functions < InputResponderPlugin
       COMMAND_WORDS = %w(functions)
-      SUMMARY = 'List all the functions available in the environment.'
+      SUMMARY = "List all the functions available in the environment."
       COMMAND_GROUP = :environment
       FUNC_NATIVE_NAME_REGEX = %r{\Afunction\s([\w\:]+)}
       FUNC_V4_NAME_REGEX = %r{Puppet\:\:Functions.create_function\s?\(?\:?\'?([\w\:]+)}
 
       def run(args = [])
-        filter = args.first || ''
+        filter = args.first || ""
         TablePrint::Printer.table_print(sorted_list(filter), [:full_name, :mod_name])
       end
 
-      def sorted_list(filter = '')
+      def sorted_list(filter = "")
         search = /#{Regexp.escape(filter)}/
-        function_map.values.find_all do | v| 
+        function_map.values.find_all do |v|
           "#{v[:mod_name]}_#{v[:full_name]}" =~ search
-        end.sort {|a,b| a[:full_name] <=> b[:full_name]}
+        end.sort { |a, b| a[:full_name] <=> b[:full_name] }
       end
 
       # append a () to functions so we know they are functions
       def func_list
-        # ideally we should get a list of function names via the puppet loader    
+        # ideally we should get a list of function names via the puppet loader
         function_map.map { |name, metadata| "#{metadata[:full_name]}()" }
       end
 
@@ -39,7 +39,6 @@ module PuppetDebugger
         functions
       end
 
-
       def lib_dirs(module_dirs = modules_paths)
         dirs = module_dirs.map do |mod_dir|
           Dir["#{mod_dir}/*/lib"].entries
@@ -47,38 +46,38 @@ module PuppetDebugger
         dirs + [puppet_debugger_lib_dir]
       end
 
-
       # @return [Array] - returns a array of the parentname and function name
       def function_obj(file)
         namespace = nil
         name = nil
         if file =~ /\.pp/
-          File.readlines(file, :encoding => 'UTF-8').find do |line|
+          File.readlines(file, :encoding => "UTF-8").find do |line|
             # TODO: not getting namespace for functio
-            if line.match(FUNC_NATIVE_NAME_REGEX) 
-              namespace, name = $1.split('::', 2) 
+            if line.match(FUNC_NATIVE_NAME_REGEX)
+              namespace, name = $1.split("::", 2)
               name = namespace if name.nil?
-              namespace = '' if namespace == name
+              namespace = "" if namespace == name
             end
           end
-        elsif file.include?('lib/puppet/functions')
-          File.readlines(file, :encoding => 'UTF-8').find do |line|
-            if line.match(FUNC_V4_NAME_REGEX) 
-              namespace, name = $1.split('::', 2) 
+        elsif file.include?("lib/puppet/functions")
+          File.readlines(file, :encoding => "UTF-8").find do |line|
+            if line.match(FUNC_V4_NAME_REGEX)
+              namespace, name = $1.split("::", 2)
               name = namespace if name.nil?
-              namespace = '' if namespace == name
+              namespace = "" if namespace == name
             end
           end
         end
-        name ||= File.basename(file, File.extname(file)) 
+        name ||= File.basename(file, File.extname(file))
         match = file.match('\/(?<mod>[\w\-\.]+)\/(lib|functions|manifests)')
-        summary_match = File.read(file, :encoding => 'UTF-8').match(/@summary\s(.*)/)
+        summary_match = File.read(file, :encoding => "UTF-8").match(/@summary\s(.*)/)
         summary = summary_match[1] if summary_match
-
-       # match = file.match('(?<mod>\w+)\/functions|manifests|lib')
-        mod_name =  match[:mod] unless match.nil? 
+        # fetch the puppet version if this is a function from puppet gem
+        captures = file.match(/(puppet-[\d\.]+)/)
+        file_namespace = captures[1] if captures
+        mod_name = match.nil? ? file_namespace : match[:mod]
         full_name = namespace.nil? || namespace.empty? ? name : name.prepend("#{namespace}::")
-        {namespace: namespace, summary: summary, mod_name: mod_name, name: name, full_name: full_name, file: file}
+        { namespace: namespace, summary: summary, mod_name: mod_name, name: name, full_name: full_name, file: file }
       end
 
       private
@@ -96,19 +95,17 @@ module PuppetDebugger
       # in the future we may want to utilize the puppet loaders to find these things
       def function_files
         search_dirs = lib_dirs.map do |lib_dir|
-          [File.join(lib_dir, 'puppet', 'functions', '**', '*.rb'),
-           File.join(lib_dir, 'functions', '**', '*.rb'),
-           File.join(File.dirname(lib_dir), 'functions', '**', '*.pp'),
-           File.join(lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
+          [File.join(lib_dir, "puppet", "functions", "**", "*.rb"),
+           File.join(lib_dir, "functions", "**", "*.rb"),
+           File.join(File.dirname(lib_dir), "functions", "**", "*.pp"),
+           File.join(lib_dir, "puppet", "parser", "functions", "*.rb")]
         end
 
         # add puppet lib directories
-        search_dirs << [File.join(puppet_lib_dir, 'puppet', 'functions', '**', '*.rb'),
-                        File.join(puppet_lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
+        search_dirs << [File.join(puppet_lib_dir, "puppet", "functions", "**", "*.rb"),
+                        File.join(puppet_lib_dir, "puppet", "parser", "functions", "*.rb")]
         Dir.glob(search_dirs.flatten)
       end
-
-
     end
   end
 end

data/lib/puppet-debugger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetDebugger
-  VERSION = "0.12.1"
+  VERSION = "0.12.2"
 end

data/spec/input_responders/functions_spec.rb

@@ -1,65 +1,73 @@
-require 'spec_helper'
-require 'puppet-debugger'
-require 'puppet-debugger/plugin_test_helper'
+require "spec_helper"
+require "puppet-debugger"
+require "puppet-debugger/plugin_test_helper"
 
 describe :functions do
-  include_examples 'plugin_tests'
+  include_examples "plugin_tests"
 
   let(:input) do
     "md5('hello')"
   end
 
   let(:mod_dir) do
-    File.join(fixtures_dir, 'modules', 'extlib')
+    File.join(fixtures_dir, "modules", "extlib")
   end
 
-  it 'runs' do
+  it "runs" do
     expect(plugin.run).to be_a String
   end
 
-  it 'returns functions' do
+  it "returns functions" do
     expect(plugin.function_map).to be_a Hash
   end
 
-  it 'sorted_list' do
+  it "sorted_list" do
     expect(plugin.sorted_list).to be_a Array
     expect(plugin.sorted_list.first).to be_a Hash
   end
 
-  it 'returns function names' do
+  it "returns function names" do
     expect(plugin.func_list).to be_a Array
-    expect(plugin.func_list.find {|m| m =~ /md5/ }).to eq('md5()')
+    expect(plugin.func_list.find { |m| m =~ /md5/ }).to eq("md5()")
   end
 
-  it 'execute md5' do
+  it "execute md5" do
     debugger_output = /5d41402abc4b2a76b9719d911017c592/
     debugger.handle_input("md5('hello')")
     expect(output.string).to match(debugger_output)
   end
 
-  it 'execute swapcase' do
+  it "execute swapcase" do
     debugger_output = /HELLO/
     debugger.handle_input("swapcase('hello')")
     expect(output.string).to match(debugger_output)
   end
 
-  it '#function_obj with native function' do
-    expect(plugin.function_obj(File.join(mod_dir, 'functions', 'dir_split.pp'))).to eq(
-      {:file=>File.join(mod_dir, 'functions', 'dir_split.pp'), :mod_name=>"extlib",
-       :full_name=>"extlib::dir_split", :name=>"extlib::dir_split", :namespace=>'extlib',
-      :summary => "Splits the given directory or directories into individual paths."}
-       )
+  it "#function_obj with native function" do
+    expect(plugin.function_obj(File.join(mod_dir, "functions", "dir_split.pp"))).to eq(
+      { :file => File.join(mod_dir, "functions", "dir_split.pp"), :mod_name => "extlib",
+        :full_name => "extlib::dir_split", :name => "extlib::dir_split", :namespace => "extlib",
+        :summary => "Splits the given directory or directories into individual paths." }
+    )
   end
 
-  it '#function_obj ruby v4 without namespace' do
-    expect(plugin.function_obj(File.join(mod_dir,'lib', 'puppet', 'functions', 'echo.rb')))
-    .to eq({:file=>File.join(mod_dir,'lib', 'puppet', 'functions', 'echo.rb'), :mod_name=>"extlib",
-       :full_name=>"echo", :name=>"echo", :namespace=>"", :summary => "DEPRECATED.  Use the namespaced function [`extlib::echo`](#extlibecho) instead."})
+  it "#function_obj ruby v4 without namespace" do
+    expect(plugin.function_obj(File.join(mod_dir, "lib", "puppet", "functions", "echo.rb"))).to eq({ :file => File.join(mod_dir, "lib", "puppet", "functions", "echo.rb"), :mod_name => "extlib",
+                                                                                                     :full_name => "echo", :name => "echo", :namespace => "", :summary => "DEPRECATED.  Use the namespaced function [`extlib::echo`](#extlibecho) instead." })
   end
 
-  it '#function_obj ruby v4 and namespace' do
-    expect(plugin.function_obj(File.join(mod_dir,'lib', 'puppet', 'functions', 'extlib', 'echo.rb')))
-    .to eq({:file=>File.join(mod_dir, 'lib', 'puppet', 'functions', 'extlib', 'echo.rb'), :mod_name=>"extlib",
-       :full_name=>"extlib::echo", :name=>"extlib::echo", :namespace=>'extlib', :summary => nil})
+  it "#function_obj ruby v4 and namespace" do
+    expect(plugin.function_obj(File.join(mod_dir, "lib", "puppet", "functions", "extlib", "echo.rb"))).to eq({ :file => File.join(mod_dir, "lib", "puppet", "functions", "extlib", "echo.rb"), :mod_name => "extlib",
+                                                                                                               :full_name => "extlib::echo", :name => "extlib::echo", :namespace => "extlib", :summary => nil })
+  end
+
+  it "#function_obj has puppet namespace" do
+    file, _ = Puppet::Functions.method(:create_function).source_location
+    dir = File.dirname(file)
+    f_obj = plugin.function_obj(File.join(dir, "functions", "include.rb"))
+    expect(f_obj[:mod_name]).to match(/puppet-.*/)
+    expect(f_obj[:name]).to eq("include")
+    expect(f_obj[:full_name]).to eq("include")
+    expect(f_obj[:summary]).to be_nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print