puppet-debugger 0.4.1 → 0.4.2

data/lib/puppet-debugger/code/code_file.rb

@@ -1,98 +1,98 @@
 
+# frozen_string_literal: true
 class CodeFile
-  class SourceNotFound < Exception
+  class SourceNotFound < RuntimeError
   end
 
-    DEFAULT_EXT = '.pp'
-
-    # List of all supported languages.
-    # @return [Hash]
-    EXTENSIONS = {
-      %w(.py)        => :python,
-      %w(.js)        => :javascript,
-      %w(.pp)        => :puppet,
-      %w(.css)       => :css,
-      %w(.xml)       => :xml,
-      %w(.php)       => :php,
-      %w(.html)      => :html,
-      %w(.diff)      => :diff,
-      %w(.java)      => :java,
-      %w(.json)      => :json,
-      %w(.c .h)      => :c,
-      %w(.rhtml)     => :rhtml,
-      %w(.yaml .yml) => :yaml,
-      %w(.cpp .hpp .cc .h cxx) => :cpp,
-      %w(.rb .ru .irbrc .gemspec .pryrc) => :ruby,
-    }
-
-    # @return [Symbol] The type of code stored in this wrapper.
-    attr_reader :code_type
-
-    # @param [String] filename The name of a file with code to be detected
-    # @param [Symbol] code_type The type of code the `filename` contains
-    def initialize(filename, code_type = type_from_filename(filename))
-      @filename = filename
-      @code_type = code_type
-    end
-
-    # @return [String] The code contained in the current `@filename`.
-    def code
-      path = abs_path
-      @code_type = type_from_filename(path)
-      File.read(path)
-    end
+  DEFAULT_EXT = '.pp'
+
+  # List of all supported languages.
+  # @return [Hash]
+  EXTENSIONS = {
+    %w(.py)        => :python,
+    %w(.js)        => :javascript,
+    %w(.pp)        => :puppet,
+    %w(.css)       => :css,
+    %w(.xml)       => :xml,
+    %w(.php)       => :php,
+    %w(.html)      => :html,
+    %w(.diff)      => :diff,
+    %w(.java)      => :java,
+    %w(.json)      => :json,
+    %w(.c .h)      => :c,
+    %w(.rhtml)     => :rhtml,
+    %w(.yaml .yml) => :yaml,
+    %w(.cpp .hpp .cc .h cxx) => :cpp,
+    %w(.rb .ru .irbrc .gemspec .pryrc) => :ruby
+  }.freeze
+
+  # @return [Symbol] The type of code stored in this wrapper.
+  attr_reader :code_type
+
+  # @param [String] filename The name of a file with code to be detected
+  # @param [Symbol] code_type The type of code the `filename` contains
+  def initialize(filename, code_type = type_from_filename(filename))
+    @filename = filename
+    @code_type = code_type
+  end
 
-    private
+  # @return [String] The code contained in the current `@filename`.
+  def code
+    path = abs_path
+    @code_type = type_from_filename(path)
+    File.read(path)
+  end
 
-    # @raise [MethodSource::SourceNotFoundError] if the `filename` is not
-    #   readable for some reason.
-    # @return [String] absolute path for the given `filename`.
-    def abs_path
-      code_path.detect { |path| readable?(path) } or
-        raise SourceNotFound,
-              "Cannot open #{ @filename.inspect } for reading."
-    end
+  private
 
-    # @param [String] path
-    # @return [Boolean] if the path, with or without the default ext,
-    #   is a readable file then `true`, otherwise `false`.
-    def readable?(path)
-      File.readable?(path) && !File.directory?(path) or
-        File.readable?(path << DEFAULT_EXT)
-    end
+  # @raise [MethodSource::SourceNotFoundError] if the `filename` is not
+  #   readable for some reason.
+  # @return [String] absolute path for the given `filename`.
+  def abs_path
+    code_path.detect { |path| readable?(path) } ||
+      raise(SourceNotFound,
+            "Cannot open #{@filename.inspect} for reading.")
+  end
 
-    # @return [Array] All the paths that contain code that Pry can use for its
-    #   API's. Skips directories.
-    def code_path
-      [from_pwd, from_pry_init_pwd, *from_load_path]
-    end
+  # @param [String] path
+  # @return [Boolean] if the path, with or without the default ext,
+  #   is a readable file then `true`, otherwise `false`.
+  def readable?(path)
+    File.readable?(path) && !File.directory?(path) ||
+      File.readable?(path << DEFAULT_EXT)
+  end
 
-    # @param [String] filename
-    # @param [Symbol] default (:unknown) the file type to assume if none could be
-    #   detected.
-    # @return [Symbol, nil] The CodeRay type of a file from its extension, or
-    #   `nil` if `:unknown`.
-    def type_from_filename(filename, default = :unknown)
-      _, @code_type = EXTENSIONS.find do |k, _|
-        k.any? { |ext| ext == File.extname(filename) }
-      end
+  # @return [Array] All the paths that contain code that Pry can use for its
+  #   API's. Skips directories.
+  def code_path
+    [from_pwd, from_pry_init_pwd, *from_load_path]
+  end
 
-      code_type || default
+  # @param [String] filename
+  # @param [Symbol] default (:unknown) the file type to assume if none could be
+  #   detected.
+  # @return [Symbol, nil] The CodeRay type of a file from its extension, or
+  #   `nil` if `:unknown`.
+  def type_from_filename(filename, default = :unknown)
+    _, @code_type = EXTENSIONS.find do |k, _|
+      k.any? { |ext| ext == File.extname(filename) }
     end
 
-    # @return [String]
-    def from_pwd
-      File.expand_path(@filename, Dir.pwd)
-    end
+    code_type || default
+  end
 
-    # @return [String]
-    def from_pry_init_pwd
-      File.expand_path(@filename, Dir.pwd)
-    end
+  # @return [String]
+  def from_pwd
+    File.expand_path(@filename, Dir.pwd)
+  end
 
-    # @return [String]
-    def from_load_path
-      $LOAD_PATH.map { |path| File.expand_path(@filename, path) }
-    end
+  # @return [String]
+  def from_pry_init_pwd
+    File.expand_path(@filename, Dir.pwd)
+  end
 
+  # @return [String]
+  def from_load_path
+    $LOAD_PATH.map { |path| File.expand_path(@filename, path) }
+  end
   end

data/lib/puppet-debugger/code/code_range.rb

@@ -1,69 +1,68 @@
-  class DebuggerCode
-
-    # Represents a range of lines in a code listing.
-    #
-    # @api private
-    class CodeRange
-
-      # @param [Integer] start_line
-      # @param [Integer?] end_line
-      def initialize(start_line, end_line = nil)
-        @start_line = start_line
-        @end_line   = end_line
-        force_set_end_line
-      end
+# frozen_string_literal: true
+class DebuggerCode
+  # Represents a range of lines in a code listing.
+  #
+  # @api private
+  class CodeRange
+    # @param [Integer] start_line
+    # @param [Integer?] end_line
+    def initialize(start_line, end_line = nil)
+      @start_line = start_line
+      @end_line   = end_line
+      force_set_end_line
+    end
 
-      # @param [Array<LOC>] lines
-      # @return [Range]
-      def indices_range(lines)
-        Range.new(*indices(lines))
-      end
+    # @param [Array<LOC>] lines
+    # @return [Range]
+    def indices_range(lines)
+      Range.new(*indices(lines))
+    end
 
-      private
+    private
 
-      def start_line; @start_line; end
-      def end_line; @end_line; end
+    attr_reader :start_line
 
-      # If `end_line` is equal to `nil`, then calculate it from the first
-      # parameter, `start_line`. Otherwise, leave it as it is.
-      # @return [void]
-      def force_set_end_line
-        if start_line.is_a?(Range)
-          set_end_line_from_range
-        else
-          @end_line ||= start_line
-        end
-      end
+    attr_reader :end_line
 
-      # Finds indices of `start_line` and `end_line` in the given Array of
-      # +lines+.
-      #
-      # @param [Array<LOC>] lines
-      # @return [Array<Integer>]
-      def indices(lines)
-        [find_start_index(lines), find_end_index(lines)]
+    # If `end_line` is equal to `nil`, then calculate it from the first
+    # parameter, `start_line`. Otherwise, leave it as it is.
+    # @return [void]
+    def force_set_end_line
+      if start_line.is_a?(Range)
+        set_end_line_from_range
+      else
+        @end_line ||= start_line
       end
+    end
 
-      # @return [Integer]
-      def find_start_index(lines)
-        return start_line if start_line < 0
-        lines.index { |loc| loc.lineno >= start_line } || lines.length
-      end
+    # Finds indices of `start_line` and `end_line` in the given Array of
+    # +lines+.
+    #
+    # @param [Array<LOC>] lines
+    # @return [Array<Integer>]
+    def indices(lines)
+      [find_start_index(lines), find_end_index(lines)]
+    end
 
-      # @return [Integer]
-      def find_end_index(lines)
-        return end_line if end_line < 0
-        (lines.index { |loc| loc.lineno > end_line } || 0) - 1
-      end
+    # @return [Integer]
+    def find_start_index(lines)
+      return start_line if start_line < 0
+      lines.index { |loc| loc.lineno >= start_line } || lines.length
+    end
 
-      # For example, if the range is 4..10, then `start_line` would be equal to
-      # 4 and `end_line` to 10.
-      # @return [void]
-      def set_end_line_from_range
-        @end_line = start_line.last
-        @end_line -= 1 if start_line.exclude_end?
-        @start_line = start_line.first
-      end
+    # @return [Integer]
+    def find_end_index(lines)
+      return end_line if end_line < 0
+      (lines.index { |loc| loc.lineno > end_line } || 0) - 1
     end
 
+    # For example, if the range is 4..10, then `start_line` would be equal to
+    # 4 and `end_line` to 10.
+    # @return [void]
+    def set_end_line_from_range
+      @end_line = start_line.last
+      @end_line -= 1 if start_line.exclude_end?
+      @start_line = start_line.first
+    end
+  end
   end

data/lib/puppet-debugger/code/loc.rb

@@ -1,80 +1,78 @@
-  class DebuggerCode
+# frozen_string_literal: true
+class DebuggerCode
+  # Represents a line of code. A line of code is a tuple, which consists of a
+  # line and a line number. A `LOC` object's state (namely, the line
+  # parameter) can be changed via instance methods. `Pry::Code` heavily uses
+  # this class.
+  #
+  # @api private
+  # @example
+  #   loc = LOC.new("def example\n  :example\nend", 1)
+  #   puts loc.line
+  #   def example
+  #     :example
+  #   end
+  #   #=> nil
+  #
+  #   loc.indent(3)
+  #   loc.line #=> "   def example\n  :example\nend"
+  class LOC
+    # @return [Array<String, Integer>]
+    attr_reader :tuple
 
-    # Represents a line of code. A line of code is a tuple, which consists of a
-    # line and a line number. A `LOC` object's state (namely, the line
-    # parameter) can be changed via instance methods. `Pry::Code` heavily uses
-    # this class.
-    #
-    # @api private
-    # @example
-    #   loc = LOC.new("def example\n  :example\nend", 1)
-    #   puts loc.line
-    #   def example
-    #     :example
-    #   end
-    #   #=> nil
-    #
-    #   loc.indent(3)
-    #   loc.line #=> "   def example\n  :example\nend"
-    class LOC
-
-      # @return [Array<String, Integer>]
-      attr_reader :tuple
-
-      # @param [String] line The line of code.
-      # @param [Integer] lineno The position of the +line+.
-      def initialize(line, lineno)
-        @tuple = [line.chomp, lineno.to_i]
-      end
-
-      # @return [Boolean]
-      def ==(other)
-        other.tuple == tuple
-      end
+    # @param [String] line The line of code.
+    # @param [Integer] lineno The position of the +line+.
+    def initialize(line, lineno)
+      @tuple = [line.chomp, lineno.to_i]
+    end
 
-      def dup
-        self.class.new(line, lineno)
-      end
+    # @return [Boolean]
+    def ==(other)
+      other.tuple == tuple
+    end
 
-      # @return [String]
-      def line
-        tuple.first
-      end
+    def dup
+      self.class.new(line, lineno)
+    end
 
-      # @return [Integer]
-      def lineno
-        tuple.last
-      end
+    # @return [String]
+    def line
+      tuple.first
+    end
 
-      #Prepends the line number `lineno` to the `line`.
-      # @param [Integer] max_width
-      # @return [void]
-      def add_line_number(max_width = 0)
-        padded = lineno.to_s.rjust(max_width)
-        tuple[0] = "#{ padded }: #{ line }"
-      end
+    # @return [Integer]
+    def lineno
+      tuple.last
+    end
 
-      # Prepends a marker "=>" or an empty marker to the +line+.
-      #
-      # @param [Integer] marker_lineno If it is equal to the `lineno`, then
-      #   prepend a hashrocket. Otherwise, an empty marker.
-      # @return [void]
-      def add_marker(marker_lineno)
-        tuple[0] =
-          if lineno == marker_lineno
-            " => #{ line }".cyan
-          else
-            "    #{ line }"
-          end
-      end
+    # Prepends the line number `lineno` to the `line`.
+    # @param [Integer] max_width
+    # @return [void]
+    def add_line_number(max_width = 0)
+      padded = lineno.to_s.rjust(max_width)
+      tuple[0] = "#{padded}: #{line}"
+    end
 
-      # Indents the `line` with +distance+ spaces.
-      #
-      # @param [Integer] distance
-      # @return [void]
-      def indent(distance)
-        tuple[0] = "#{ ' ' * distance }#{ line }"
-      end
+    # Prepends a marker "=>" or an empty marker to the +line+.
+    #
+    # @param [Integer] marker_lineno If it is equal to the `lineno`, then
+    #   prepend a hashrocket. Otherwise, an empty marker.
+    # @return [void]
+    def add_marker(marker_lineno)
+      tuple[0] =
+        if lineno == marker_lineno
+          " => #{line}".cyan
+        else
+          "    #{line}"
+        end
     end
 
+    # Indents the `line` with +distance+ spaces.
+    #
+    # @param [Integer] distance
+    # @return [void]
+    def indent(distance)
+      tuple[0] = "#{' ' * distance}#{line}"
+    end
+  end
   end