puppet-debugger 0.19.0 → 1.0.0

data/output.json

@@ -0,0 +1 @@
+{"output":"\"Facts were removed for easier viewing\"\n{\n \"facts\"        => \"removed by the puppet-debugger\",\n \"module_name\"  => \"\",\n \"name\"         => \"main\",\n \"server_facts\" => {\n  \"environment\"   => \"production\",\n  \"serverip\"      => \"172.20.5.187\",\n  \"servername\"    => \"MacBook-Pro-162.local\",\n  \"serverversion\" => \"4.10.12\"\n },\n \"title\"        => \"main\",\n \"trusted\"      => {\n  \"authenticated\" => \"local\",\n  \"certname\"      => nil,\n  \"domain\"        => nil,\n  \"extensions\"    => {},\n  \"hostname\"      => nil\n }\n}\n"}

data/puppet-debugger.gemspec

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'lib/puppet-debugger/version'
 require 'date'
 
@@ -7,7 +8,7 @@ Gem::Specification.new do |s|
   s.version = PuppetDebugger::VERSION
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|resources|local_test_results|pec)/}) }
   s.bindir        = 'bin'
-  s.executables = ['pdb', 'puppet-debugger']
+  s.executables = %w[pdb puppet-debugger]
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if s.respond_to?(:metadata)
@@ -26,19 +27,19 @@ Gem::Specification.new do |s|
     'LICENSE.txt',
     'README.md'
   ]
-  s.required_ruby_version = '>= 2.1'
-  s.homepage = "https://gitlab.com/puppet-debugger/puppet-debugger"
-  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"])
-  s.add_runtime_dependency(%q<bundler>)
-  s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-  s.add_development_dependency(%q<rspec>, ["~> 3.6"])
-
+  s.required_ruby_version = '>= 2.4'
+  s.homepage = 'https://gitlab.com/puppet-debugger/puppet-debugger'
+  s.licenses = ['MIT']
+  s.rubygems_version = '2.4.5.1'
+  s.summary = 'A repl based debugger for the puppet language'
+  s.add_runtime_dependency('awesome_print', ['~> 1.7'])
+  s.add_runtime_dependency('bundler')
+  s.add_runtime_dependency('facterdb', ['>= 0.4.0'])
+  s.add_runtime_dependency('pluginator', ['~> 1.5.0'])
+  s.add_runtime_dependency('puppet', ['>= 5.5'])
+  s.add_runtime_dependency('rb-readline', ['>= 0.5.5'])
+  s.add_runtime_dependency('table_print', ['>= 1.0.0'])
+  s.add_runtime_dependency('tty-pager', ['~> 0.13.0'])
+  s.add_development_dependency('rdoc', ['~> 3.12'])
+  s.add_development_dependency('rspec', ['~> 3.6'])
 end

data/spec/awesome_print/ext/awesome_puppet_spec.rb

@@ -1,37 +1,37 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'awesome_print'
-require "awesome_print/ext/awesome_puppet"
+require 'awesome_print/ext/awesome_puppet'
 
 RSpec.describe do
-    let(:output) do
-        StringIO.new
-      end
-    
-      let(:debugger) do
-        PuppetDebugger::Cli.new(options)
-      end
-    
-      let(:options) do
-        {
-            out_buffer: output
-        }
-      end
-    
-      let(:input) do
-        "notify{'ff:gg': }"
-      end
-    
-      let(:resource_type) do
-        debugger.parser.evaluate_string(debugger.scope, input).first
-      end
-
-      let(:ral_type) do
-        debugger.scope.catalog.resource(resource_type.type_name, resource_type.title).to_ral
-      end
-
-      it 'outputs awesomely' do
-        expect(ral_type.ai).to include('ff:gg')
-      end
+  let(:output) do
+    StringIO.new
+  end
+
+  let(:debugger) do
+    PuppetDebugger::Cli.new(options)
+  end
+
+  let(:options) do
+    {
+      out_buffer: output
+    }
+  end
+
+  let(:input) do
+    "notify{'ff:gg': }"
+  end
+
+  let(:resource_type) do
+    debugger.parser.evaluate_string(debugger.scope, input).first
+  end
 
+  let(:ral_type) do
+    debugger.scope.catalog.resource(resource_type.type_name, resource_type.title).to_ral
+  end
 
+  it 'outputs awesomely' do
+    expect(ral_type.ai).to include('ff:gg')
+  end
 end

data/spec/fixtures/sample_start_debugger.pp

@@ -7,7 +7,8 @@ class sample_test_breakpoint(
     ensure => present,
   }
   range(1,5).map | $num | {
-    start_repl()
+    $num * $num
   }
+  debug::breaK()
 }
-include sample_test_breakpoint
+include sample_test_breakpoint

data/spec/hooks_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'spec_helper'
 
 describe PuppetDebugger::Hooks do
@@ -12,8 +14,8 @@ describe PuppetDebugger::Hooks do
   let(:debugger) do
     PuppetDebugger::Cli.new(out_buffer: output)
   end
-  
-  describe "adding a new hook" do
+
+  describe 'adding a new hook' do
     it 'should not execute hook while adding it' do
       run = false
       @hooks.add_hook(:test_hook, :my_name) { run = true }
@@ -27,12 +29,12 @@ describe PuppetDebugger::Hooks do
     end
 
     it 'should create a new hook with a block' do
-      @hooks.add_hook(:test_hook, :my_name) { }
+      @hooks.add_hook(:test_hook, :my_name) {}
       expect(@hooks.hook_count(:test_hook)).to eq 1
     end
 
     it 'should create a new hook with a callable' do
-      @hooks.add_hook(:test_hook, :my_name, proc { })
+      @hooks.add_hook(:test_hook, :my_name, proc {})
       expect(@hooks.hook_count(:test_hook)).to eq 1
     end
 
@@ -61,8 +63,8 @@ describe PuppetDebugger::Hooks do
     end
   end
 
-  describe "PuppetDebugger::Hooks#merge" do
-    describe "merge!" do
+  describe 'PuppetDebugger::Hooks#merge' do
+    describe 'merge!' do
       it 'should merge in the PuppetDebugger::Hooks' do
         h1 = PuppetDebugger::Hooks.new.add_hook(:test_hook, :testing) {}
         h2 = PuppetDebugger::Hooks.new
@@ -101,22 +103,19 @@ describe PuppetDebugger::Hooks do
       end
 
       it 'should preserve hook order' do
-        name = ""
+        test_hook_name = String.new
         h1 = PuppetDebugger::Hooks.new
-        h1.add_hook(:test_hook, :testing3) { name << "h" }
-        h1.add_hook(:test_hook, :testing4) { name << "n" }
+        h1.add_hook(:test_hook, :testing3) { test_hook_name << 'h' }
+        h1.add_hook(:test_hook, :testing4) { test_hook_name << 'n' }
 
         h2 = PuppetDebugger::Hooks.new
-        h2.add_hook(:test_hook, :testing1) { name << "j" }
-        h2.add_hook(:test_hook, :testing2) { name << "o" }
-
+        h2.add_hook(:test_hook, :testing1) { test_hook_name << 'j' }
+        h2.add_hook(:test_hook, :testing2) { test_hook_name << 'o' }
         h2.merge!(h1)
-        h2.exec_hook(:test_hook)
-
-        expect(name).to eq "john"
+        expect(h2.exec_hook(:test_hook)).to eq 'john'
       end
 
-      describe "merge" do
+      describe 'merge' do
         it 'should return a fresh, independent instance' do
           h1 = PuppetDebugger::Hooks.new.add_hook(:test_hook, :testing) {}
           h2 = PuppetDebugger::Hooks.new
@@ -146,11 +145,10 @@ describe PuppetDebugger::Hooks do
           expect(h2.get_hook(:test_hook3, :testing)).to eq nil
         end
       end
-
     end
   end
 
-  describe "dupping a PuppetDebugger::Hooks instance" do
+  describe 'dupping a PuppetDebugger::Hooks instance' do
     it 'should share hooks with original' do
       @hooks.add_hook(:test_hook, :testing) do
         :none_such
@@ -177,11 +175,10 @@ describe PuppetDebugger::Hooks do
 
       expect(hooks_dup.get_hook(:test_hook, :testing2)).not_to eq @hooks.get_hook(:test_hook, :testing2)
     end
-
   end
 
-  describe "getting hooks" do
-    describe "get_hook" do
+  describe 'getting hooks' do
+    describe 'get_hook' do
       it 'should return the correct requested hook' do
         run = false
         fun = false
@@ -197,7 +194,7 @@ describe PuppetDebugger::Hooks do
       end
     end
 
-    describe "get_hooks" do
+    describe 'get_hooks' do
       it 'should return a hash of hook names/hook functions for an event' do
         hook1 = proc { 1 }
         hook2 = proc { 2 }
@@ -215,17 +212,17 @@ describe PuppetDebugger::Hooks do
     end
   end
 
-  describe "clearing all hooks for an event" do
+  describe 'clearing all hooks for an event' do
     it 'should clear all hooks' do
-      @hooks.add_hook(:test_hook, :my_name) { }
-      @hooks.add_hook(:test_hook, :my_name2) { }
-      @hooks.add_hook(:test_hook, :my_name3) { }
+      @hooks.add_hook(:test_hook, :my_name) {}
+      @hooks.add_hook(:test_hook, :my_name2) {}
+      @hooks.add_hook(:test_hook, :my_name3) {}
       @hooks.clear_event_hooks(:test_hook)
       expect(@hooks.hook_count(:test_hook)).to eq 0
     end
   end
 
-  describe "deleting a hook" do
+  describe 'deleting a hook' do
     it 'should successfully delete a hook' do
       @hooks.add_hook(:test_hook, :my_name) {}
       @hooks.delete_hook(:test_hook, :my_name)
@@ -244,7 +241,7 @@ describe PuppetDebugger::Hooks do
     end
   end
 
-  describe "executing a hook" do
+  describe 'executing a hook' do
     it 'should execute block hook' do
       run = false
       @hooks.add_hook(:test_hook, :my_name) { run = true }
@@ -264,7 +261,9 @@ describe PuppetDebugger::Hooks do
         obj.instance_variable_set(:@test_var, nil)
         class << obj
           attr_accessor :test_var
-          def call() @test_var = true; end
+          def call
+            @test_var = true
+          end
         end
       end
 
@@ -304,7 +303,7 @@ describe PuppetDebugger::Hooks do
       @hooks.add_hook(:test_hook, :foo2) { raise 'two' }
       @hooks.add_hook(:test_hook, :foo3) { raise 'three' }
       @hooks.exec_hook(:test_hook)
-      expect(@hooks.errors.map(&:message)).to eq ['one', 'two', 'three']
+      expect(@hooks.errors.map(&:message)).to eq %w[one two three]
     end
 
     it 'should return the last exception raised as the return value' do
@@ -315,15 +314,15 @@ describe PuppetDebugger::Hooks do
     end
   end
 
-  describe "anonymous hooks" do
+  describe 'anonymous hooks' do
     it 'should allow adding of hook without a name' do
       @hooks.add_hook(:test_hook, nil) {}
       expect(@hooks.hook_count(:test_hook)).to eq 1
     end
 
     it 'should only allow one anonymous hook to exist' do
-      @hooks.add_hook(:test_hook, nil) {  }
-      @hooks.add_hook(:test_hook, nil) {  }
+      @hooks.add_hook(:test_hook, nil) {}
+      @hooks.add_hook(:test_hook, nil) {}
       expect(@hooks.hook_count(:test_hook)).to eq 1
     end
 
@@ -337,5 +336,4 @@ describe PuppetDebugger::Hooks do
       expect(x).to eq 2
     end
   end
-
-end
+end

data/spec/input_responder_plugin_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'puppet-debugger/input_responder_plugin'
 
@@ -28,18 +30,17 @@ describe :input_responder_plugin do
     expect(plugin.run([])).to eq([])
   end
 
-  {scope: Puppet::Parser::Scope, node: Puppet::Node, facts: Puppet::Node::Facts,
-   environment: Puppet::Node::Environment,
-  compiler: Puppet::Parser::Compiler, catalog: Puppet::Resource::Catalog}.each do |name, klass|
+  { scope: Puppet::Parser::Scope, node: Puppet::Node, facts: Puppet::Node::Facts,
+    environment: Puppet::Node::Environment,
+    compiler: Puppet::Parser::Compiler, catalog: Puppet::Resource::Catalog }.each do |name, klass|
     it "can access #{name}" do
       expect(plugin.send(name).class).to be klass
     end
   end
 
-  [:add_hook, :handle_input, :delete_hook, :handle_input].each do |name|
+  %i[add_hook handle_input delete_hook handle_input].each do |name|
     it "responds to method #{name}" do
       expect(plugin.respond_to?(name)).to eq(true)
     end
   end
-
-end
+end

data/spec/input_responders/benchmark_spec.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'puppet-debugger'
 require 'puppet-debugger/plugin_test_helper'
 
 describe :benchmark do
   include_examples 'plugin_tests'
-  let(:args) { ["benchmark", "md5('12345')" ] }
+  let(:args) { ['benchmark', "md5('12345')"] }
 
   describe 'mode' do
     before(:each) do

data/spec/input_responders/classes_spec.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'puppet-debugger'
 require 'puppet-debugger/plugin_test_helper'
 
 describe :classes do
   include_examples 'plugin_tests'
-    let(:input) do
-      'classes'
-    end
+  let(:input) do
+    'classes'
+  end
 
-    it 'should be able to print classes' do
-      expect(plugin.run([])).to match(/settings/)
-    end
+  it 'should be able to print classes' do
+    expect(plugin.run([])).to match(/settings/)
+  end
 
-    it 'should be able to print classes with handle input' do
-      debugger_output = /settings/
-      expect(plugin.run(['settings'])).to match(debugger_output)
-    end
+  it 'should be able to print classes with handle input' do
+    debugger_output = /settings/
+    expect(plugin.run(['settings'])).to match(debugger_output)
+  end
 end

data/spec/input_responders/classification_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'puppet-debugger'
 require 'puppet-debugger/plugin_test_helper'
@@ -7,11 +9,11 @@ describe :classification do
   let(:args) { [] }
 
   it 'can process a file' do
-    expect(plugin.run(args)).to eq("[]")
+    expect(plugin.run(args)).to eq('[]')
   end
 
   it 'can process a file from handle input' do
     debugger.handle_input('classification')
-    expect(output.string).to eq("[]\n")
+    expect(output.string).to eq(" => []\n")
   end
 end

data/spec/input_responders/commands_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'puppet-debugger'
 require 'puppet-debugger/plugin_test_helper'

data/spec/input_responders/datatypes_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'puppet-debugger'
 require 'puppet-debugger/plugin_test_helper'
@@ -9,7 +11,7 @@ describe :datatypes do
   it 'handle datatypes' do
     output = plugin.run(args)
     if Gem::Version.new(Puppet.version) < Gem::Version.new('4.5.0')
-      expect(output).to eq("[]")
+      expect(output).to eq('[]')
     else
       expect(output).to match(/.*Array.*/)
     end
@@ -21,7 +23,6 @@ describe :datatypes do
     else
       expect(plugin.all_data_types.count).to be >= 30 if supports_datatypes?
     end
-
   end
 
   it 'returns environment datatypes' do
@@ -30,6 +31,6 @@ describe :datatypes do
 
   it 'search datatypes' do
     output = plugin.run(['integer'])
-    expect(output.split("Integer").count).to be >= 2
+    expect(output.split('Integer').count).to be >= 2
   end
 end

data/spec/input_responders/environment_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'puppet-debugger'
 require 'puppet-debugger/plugin_test_helper'