puppet-debugger 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56bddbd88e1782f203b95319c3774d48d0421cf328ffd82df8118edb76b87e55
-  data.tar.gz: fec7e054cc3a5ce5bee5a0aada0ef970e4ca34518a8c25010bf817f32fe7b64f
+  metadata.gz: e98e90f35a13e50b2b3f02e7c8b5aa590daa90b31df68a868403fba0399ef35e
+  data.tar.gz: 10bee3e410b82be3c5ff0f8134b6ac1fb8c38cfc2a1d21a10bbd214059ba6434
 SHA512:
-  metadata.gz: c6ef7818ca1de88313ad413332f2181e65b0fbd889a076cf45a26c69ae73e669d4435d371033adc28c6acaa9c0a8cc3a61e6924e699036a86194a758fb87a370
-  data.tar.gz: 21b119f7e65f4224f2f68422434878a03c74f35cfdb844b428365b96d4d12b538c599224670f625821eaa5acd46f9cfd880370d7ccb3b983a74960125f438e0e
+  metadata.gz: c4ab1e0c51864faf1f53ac54b7a54f158e74e446888b6671a1d51ec48a8fb316b15419330d98d8e350b0e7df2875e47c3d88c840bd6b72e1679fc2ae5eb89a00
+  data.tar.gz: 6185292e9b63138cee9727c78d305e8ed00e463ba43b27a44d0ff7b0e42c0d76d098263a8a6987b771f89d561950fc5cc0eac8c637e332c53d69692c2dce11cf

data/.gitlab-ci.yml

@@ -58,14 +58,13 @@ bump_and_tag:
 #  script:
 #    - "curl -X POST -F token=$PREPL_BUILD_TRIGGER_TOKEN -F ref=$REF https://gitlab.com/api/v3/projects/1146764/trigger/builds"
 
-.ruby_20: &ruby20
-  image: ruby:2.0
-
-.ruby_21: &ruby21
-  image: ruby:2.1
-
 .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
 
 .ruby_23: &ruby23
   image: ruby:2.3
@@ -76,8 +75,12 @@ bump_and_tag:
 .ruby_25: &ruby25
   image: ruby:2.5
 
+
+.ruby_25: &ruby26
+  image: ruby:2.6
+
 gem_production:
-  image: ruby:2.1
+  image: ruby:2.5
   tags:
     - ruby
   before_script:
@@ -88,54 +91,18 @@ gem_production:
   only:
     - tags
 
-puppet_38_ruby20:
-  variables:
-    PUPPET_GEM_VERSION: "~> 3.8.0"
-  <<: *puppet_job_def
-  <<: *ruby20
-
-puppet_38_ruby21:
-  variables:
-    PUPPET_GEM_VERSION: "~> 3.8.0"
-  <<: *puppet_job_def
-  <<: *ruby21
-
-puppet_43_ruby20:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.3.0"
-  <<: *puppet_job_def
-  <<: *ruby20
-
-puppet_43_ruby21:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.3.0"
-  <<: *puppet_job_def
-  <<: *ruby21
-
 puppet_43_ruby22:
   variables:
     PUPPET_GEM_VERSION: "~> 4.3.0"
   <<: *puppet_job_def
   <<: *ruby22
 
-puppet_44_ruby21:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.4.0"
-  <<: *puppet_job_def
-  <<: *ruby21
-
 puppet_44_ruby22:
   variables:
     PUPPET_GEM_VERSION: "~> 4.4.0"
   <<: *puppet_job_def
   <<: *ruby22
 
-puppet_45_ruby21:
-  variables:
-    PUPPET_GEM_VERSION: "~> 4.5.0"
-  <<: *puppet_job_def
-  <<: *ruby21
-
 puppet_46_ruby22:
   variables:
     PUPPET_GEM_VERSION: "~> 4.6.0"
@@ -154,37 +121,6 @@ puppet_410_ruby24:
   <<: *puppet_job_def
   <<: *ruby24
 
-puppet_50_ruby24:
-  variables:
-    PUPPET_GEM_VERSION: "~> 5.0"
-  <<: *puppet_job_def
-  <<: *ruby24
-
-puppet_51_ruby24:
-  variables:
-    PUPPET_GEM_VERSION: "~> 5.1"
-  <<: *puppet_job_def
-  <<: *ruby24
-
-puppet_52_ruby24:
-  variables:
-    PUPPET_GEM_VERSION: "~> 5.2"
-  <<: *puppet_job_def
-  <<: *ruby24
-
-puppet_53_ruby24:
-  variables:
-    PUPPET_GEM_VERSION: "~> 5.3"
-  <<: *puppet_job_def
-  <<: *ruby24
-
-
-puppet_54_ruby24:
-  variables:
-    PUPPET_GEM_VERSION: "~> 5.4"
-  <<: *puppet_job_def
-  <<: *ruby24
-
 puppet_55_ruby24:
   variables:
     PUPPET_GEM_VERSION: "~> 5.5"
@@ -196,3 +132,9 @@ puppet_60_ruby25:
     PUPPET_GEM_VERSION: "~> 6.0"
   <<: *puppet_job_def
   <<: *ruby25
+
+puppet_60_ruby25:
+  variables:
+    PUPPET_GEM_VERSION: "~> 6.4"
+  <<: *puppet_job_def
+  <<: *ruby25

data/.rubocop_todo.yml

@@ -12,12 +12,12 @@
 # SupportedStyles: start_of_line, def
 Lint/DefEndAlignment:
   Exclude:
-    - 'lib/puppet-debugger/support/errors.rb'
+    - "lib/puppet-debugger/support/errors.rb"
 
 # Offense count: 1
 Lint/ElseLayout:
   Exclude:
-    - 'lib/puppet-debugger/support/play.rb'
+    - "lib/puppet-debugger/support/play.rb"
 
 # Offense count: 10
 # Cop supports --auto-correct.
@@ -25,39 +25,39 @@ Lint/ElseLayout:
 # SupportedStyles: keyword, variable, start_of_line
 Lint/EndAlignment:
   Exclude:
-    - 'lib/puppet-debugger/code/code_file.rb'
-    - 'lib/puppet-debugger/code/code_range.rb'
-    - 'lib/puppet-debugger/code/loc.rb'
-    - 'lib/trollop.rb'
+    - "lib/puppet-debugger/code/code_file.rb"
+    - "lib/puppet-debugger/code/code_range.rb"
+    - "lib/puppet-debugger/code/loc.rb"
+    - "lib/trollop.rb"
 
 # Offense count: 3
 Lint/HandleExceptions:
   Exclude:
-    - 'lib/puppet-debugger/support.rb'
-    - 'lib/trollop.rb'
+    - "lib/puppet-debugger/support.rb"
+    - "lib/trollop.rb"
 
 # Offense count: 1
 Lint/NestedMethodDefinition:
   Exclude:
-    - 'lib/trollop.rb'
+    - "lib/trollop.rb"
 
 # Offense count: 1
 Lint/ShadowingOuterLocalVariable:
   Exclude:
-    - 'lib/puppet-debugger/support/input_responders.rb'
+    - "lib/puppet-debugger/support/input_responders.rb"
 
 # Offense count: 18
 Lint/UselessAssignment:
   Exclude:
-    - 'lib/puppet-debugger/support.rb'
-    - 'lib/puppet-debugger/support/environment.rb'
-    - 'lib/puppet-debugger/support/errors.rb'
-    - 'lib/puppet-debugger/support/functions.rb'
-    - 'lib/puppet-debugger/support/input_responders.rb'
-    - 'lib/puppet-debugger/support/node.rb'
-    - 'lib/puppet-debugger/support/play.rb'
-    - 'lib/puppet/application/debugger.rb'
-    - 'spec/support_spec.rb'
+    - "lib/puppet-debugger/support.rb"
+    - "lib/puppet-debugger/support/environment.rb"
+    - "lib/puppet-debugger/support/errors.rb"
+    - "lib/puppet-debugger/support/functions.rb"
+    - "lib/puppet-debugger/support/input_responders.rb"
+    - "lib/puppet-debugger/support/node.rb"
+    - "lib/puppet-debugger/support/play.rb"
+    - "lib/puppet/application/debugger.rb"
+    - "spec/support_spec.rb"
 
 # Offense count: 22
 Metrics/AbcSize:
@@ -107,78 +107,78 @@ Metrics/PerceivedComplexity:
 # Cop supports --auto-correct.
 Performance/RedundantMatch:
   Exclude:
-    - 'lib/awesome_print/ext/awesome_puppet.rb'
+    - "lib/awesome_print/ext/awesome_puppet.rb"
 
 # Offense count: 8
 Style/AccessorMethodName:
   Exclude:
-    - 'lib/puppet-debugger/support/compiler.rb'
-    - 'lib/puppet-debugger/support/environment.rb'
-    - 'lib/puppet-debugger/support/facts.rb'
-    - 'lib/puppet-debugger/support/input_responders.rb'
-    - 'lib/puppet-debugger/support/node.rb'
-    - 'lib/puppet-debugger/support/scope.rb'
+    - "lib/puppet-debugger/support/compiler.rb"
+    - "lib/puppet-debugger/support/environment.rb"
+    - "lib/puppet-debugger/support/facts.rb"
+    - "lib/puppet-debugger/support/input_responders.rb"
+    - "lib/puppet-debugger/support/node.rb"
+    - "lib/puppet-debugger/support/scope.rb"
 
 # Offense count: 2
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Exclude:
-    - 'lib/puppet/application/debugger.rb'
-    - 'spec/spec_helper.rb'
+    - "lib/puppet/application/debugger.rb"
+    - "spec/spec_helper.rb"
 
 # Offense count: 21
 Style/Documentation:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/awesome_print/ext/awesome_puppet.rb'
-    - 'lib/puppet-debugger/cli.rb'
-    - 'lib/puppet-debugger/code/code_file.rb'
-    - 'lib/puppet-debugger/support.rb'
-    - 'lib/puppet-debugger/support/compiler.rb'
-    - 'lib/puppet-debugger/support/environment.rb'
-    - 'lib/puppet-debugger/support/errors.rb'
-    - 'lib/puppet-debugger/support/facts.rb'
-    - 'lib/puppet-debugger/support/functions.rb'
-    - 'lib/puppet-debugger/support/input_responders.rb'
-    - 'lib/puppet-debugger/support/node.rb'
-    - 'lib/puppet-debugger/support/play.rb'
-    - 'lib/puppet-debugger/support/scope.rb'
-    - 'lib/puppet/application/debugger.rb'
-    - 'lib/trollop.rb'
+    - "spec/**/*"
+    - "test/**/*"
+    - "lib/awesome_print/ext/awesome_puppet.rb"
+    - "lib/puppet-debugger/cli.rb"
+    - "lib/puppet-debugger/code/code_file.rb"
+    - "lib/puppet-debugger/support.rb"
+    - "lib/puppet-debugger/support/compiler.rb"
+    - "lib/puppet-debugger/support/environment.rb"
+    - "lib/puppet-debugger/support/errors.rb"
+    - "lib/puppet-debugger/support/facts.rb"
+    - "lib/puppet-debugger/support/functions.rb"
+    - "lib/puppet-debugger/support/input_responders.rb"
+    - "lib/puppet-debugger/support/node.rb"
+    - "lib/puppet-debugger/support/play.rb"
+    - "lib/puppet-debugger/support/scope.rb"
+    - "lib/puppet/application/debugger.rb"
+    - "lib/trollop.rb"
 
 # Offense count: 2
 Style/DoubleNegation:
   Exclude:
-    - 'lib/puppet-debugger/debugger_code.rb'
+    - "lib/puppet-debugger/debugger_code.rb"
 
 # Offense count: 10
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'lib/puppet-debugger/cli.rb'
-    - 'lib/puppet-debugger/support.rb'
-    - 'lib/puppet-debugger/support/input_responders.rb'
-    - 'lib/puppet-debugger/support/play.rb'
-    - 'lib/trollop.rb'
+    - "lib/puppet-debugger/cli.rb"
+    - "lib/puppet-debugger/support.rb"
+    - "lib/puppet-debugger/support/input_responders.rb"
+    - "lib/puppet-debugger/support/play.rb"
+    - "lib/trollop.rb"
     - puppet-debugger.gemspec
 
 # Offense count: 2
 Style/IdenticalConditionalBranches:
   Exclude:
-    - 'lib/puppet-debugger/support/play.rb'
+    - "lib/puppet-debugger/support/play.rb"
 
 # Offense count: 2
 Style/MethodMissing:
   Exclude:
-    - 'lib/puppet-debugger/debugger_code.rb'
-    - 'lib/trollop.rb'
+    - "lib/puppet-debugger/debugger_code.rb"
+    - "lib/trollop.rb"
 
 # Offense count: 1
 Style/MultilineTernaryOperator:
   Exclude:
-    - 'lib/puppet/application/debugger.rb'
+    - "lib/puppet/application/debugger.rb"
 
 # Offense count: 2
 # Cop supports --auto-correct.
@@ -186,8 +186,8 @@ Style/MultilineTernaryOperator:
 # SupportedStyles: predicate, comparison
 Style/NumericPredicate:
   Exclude:
-    - 'spec/**/*'
-    - 'lib/puppet-debugger/code/code_range.rb'
+    - "spec/**/*"
+    - "lib/puppet-debugger/code/code_range.rb"
 
 # Offense count: 3
 # Cop supports --auto-correct.
@@ -195,11 +195,11 @@ Style/NumericPredicate:
 # SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Exclude:
-    - 'spec/puppet_debugger_spec.rb'
+    - "spec/puppet_debugger_spec.rb"
 
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: AllowAsExpressionSeparator.
 Style/Semicolon:
   Exclude:
-    - 'lib/puppet/application/debugger.rb'
+    - "lib/puppet/application/debugger.rb"

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
 
+## 0.11.0
+
+- Fixes native functions not shown in functions command
+- Prints functions into a table with proper namespace shown
+- Adds table print gem
+- Adds rb-readline for universal readline support on all platforms
+
 ## 0.10.3
 
 - Remove warning message about incorrect version

data/Gemfile

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 source 'http://rubygems.org'
 gem 'awesome_print', '~> 1.7'
-gem 'facterdb', '>= 0.4.0'
+gem 'facterdb', '>= 0.5.0'
 gem 'puppet', ENV['PUPPET_GEM_VERSION'] || '~> 4.10.1'
 gem 'pluginator', '~> 1.5.0'
-
+gem 'rb-readline'
+gem 'table_print'
 group :test, :development do
   # ruby versions prior to 2.0 cannot install json_pure 2.0.2+
   gem 'bundler'

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

@@ -1,15 +1,114 @@
 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.'
       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 || ''
-        function_map.keys.sort.grep(/^#{Regexp.escape(filter)}/)
+        TablePrint::Printer.table_print(sorted_list(filter), [:full_name, :mod_name])
+      end
+
+      def sorted_list(filter = '')
+        search = /#{Regexp.escape(filter)}/
+        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
+
+      # 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    
+        function_map.map { |name, metadata| "#{metadata[:full_name]}()" }
+      end
+
+      # @return [Hash] - a map of all the functions
+      def function_map
+        functions = {}
+        function_files.each do |file|
+          obj = function_obj(file)
+          # return the last matched in cases where rbenv might be involved
+          functions[obj[:full_name]] = obj
+        end
+        functions
+      end
+
+
+      def lib_dirs(module_dirs = modules_paths)
+        dirs = module_dirs.map do |mod_dir|
+          Dir["#{mod_dir}/*/lib"].entries
+        end.flatten
+        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|
+            # TODO: not getting namespace for functio
+            if line.match(FUNC_NATIVE_NAME_REGEX) 
+              namespace, name = $1.split('::', 2) 
+              name = namespace if name.nil?
+              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) 
+              name = namespace if name.nil?
+              namespace = '' if namespace == name
+            end
+          end
+        end
+        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 = summary_match[1] if summary_match
+
+       # match = file.match('(?<mod>\w+)\/functions|manifests|lib')
+        mod_name =  match[:mod] unless match.nil? 
+        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}
+      end
+
+      private
+
+      # load all the lib dirs so puppet can find the functions
+      # at this time, this function is not being used
+      def load_lib_dirs(module_dirs = modules_paths)
+        lib_dirs(module_dirs).each do |lib|
+          $LOAD_PATH << lib
+        end
       end
+
+      # returns a array of function files which is only required
+      # when displaying the function map, puppet will load each function on demand
+      # 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')]
+        end
+
+        # add puppet lib directories
+        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/cli.rb

@@ -69,8 +69,7 @@ module PuppetDebugger
       variables = scope.to_hash.keys
       # prepend a :: to topscope variables
       scoped_vars = variables.map { |k, _v| scope.compiler.topscope.exist?(k) ? "$::#{k}" : "$#{k}" }
-      # append a () to functions so we know they are functions
-      funcs = function_map.keys.map { |k| "#{k.split('::').last}()" }
+      funcs = PuppetDebugger::InputResponders::Functions.instance.func_list
       PuppetDebugger::InputResponders::Datatypes.instance.debugger = self
       (scoped_vars + funcs + static_responder_list + PuppetDebugger::InputResponders::Datatypes.instance.all_data_types).uniq.sort
     end

data/lib/puppet-debugger/input_responder_plugin.rb

@@ -8,7 +8,7 @@ module PuppetDebugger
       extend Forwardable
       attr_accessor :debugger
       def_delegators :debugger, :scope, :node, :environment, :loaders, :puppet_environment,
-                     :add_hook, :handle_input, :delete_hook, :function_map
+                     :add_hook, :handle_input, :delete_hook, :puppet_lib_dir, :modules_paths
       def_delegators :scope, :compiler, :catalog
       def_delegators :node, :facts
 
@@ -53,5 +53,12 @@ module PuppetDebugger
       def run(args = [])
         raise NotImplementedError
       end
+
+      # this is the lib directory of this gem
+      # in order to load any puppet functions from this gem we need to add the lib path
+      # of this gem
+      def puppet_debugger_lib_dir
+        File.expand_path(File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'lib'))
+      end
     end
 end

data/lib/puppet-debugger/support.rb

@@ -15,7 +15,6 @@ module PuppetDebugger
     include PuppetDebugger::Support::Environment
     include PuppetDebugger::Support::Facts
     include PuppetDebugger::Support::Scope
-    include PuppetDebugger::Support::Functions
     include PuppetDebugger::Support::Node
     include PuppetDebugger::Support::Loader
 
@@ -44,14 +43,27 @@ module PuppetDebugger
       end
     end
 
+    def lib_dirs(module_dirs = modules_paths)
+      dirs = module_dirs.map do |mod_dir|
+        Dir["#{mod_dir}/*/lib"].entries
+      end.flatten
+      dirs + [puppet_debugger_lib_dir]
+    end
+
     def static_responder_list
       PuppetDebugger::InputResponders::Commands.command_list
     end
 
+    # returns either the module name or puppet version
+    def mod_finder
+      @mod_finder ||= Regexp.new('\/([\w\-\.]+)\/lib')
+    end
+
     # this is the lib directory of this gem
     # in order to load any puppet functions from this gem we need to add the lib path
     # of this gem
-    def puppet_repl_lib_dir
+    # @deprecated
+    def puppet_debugger_lib_dir
       File.expand_path(File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'lib'))
     end
 

data/lib/puppet-debugger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetDebugger
-  VERSION = '0.10.3'
+  VERSION = '0.11.0'
 end

data/puppet-debugger.gemspec

@@ -30,7 +30,9 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.rubygems_version = "2.4.5.1"
   s.summary = "A repl based debugger for the puppet language"
+  s.add_runtime_dependency(%q<table_print>, [">= 1.0.0"])
   s.add_runtime_dependency(%q<pluginator>, ["~> 1.5.0"])
+  s.add_runtime_dependency(%q<rb-readline>, ['>= 0.5.5'])
   s.add_runtime_dependency(%q<puppet>, [">= 3.8"])
   s.add_runtime_dependency(%q<facterdb>, [">= 0.4.0"])
   s.add_runtime_dependency(%q<awesome_print>, ["~> 1.7"])

data/spec/fixtures/modules/extlib/.editorconfig

@@ -0,0 +1,14 @@
+# editorconfig.org
+
+# MANAGED BY MODULESYNC
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+tab_width = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

data/spec/fixtures/modules/extlib/.fixtures.yml

@@ -0,0 +1,3 @@
+fixtures:
+  repositories:
+    stdlib: "git://github.com/puppetlabs/puppetlabs-stdlib.git"