method_introspection 0.0.2 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f8e37158912e43ca147a709371c78620db8933fb
-  data.tar.gz: f1e14b2af4e5a389b52020a0bd0b64f6da5e021e
+SHA256:
+  metadata.gz: f71ee73fbfe1d022cfde4dddb654925ccfd7ad3505656040378f616d94b4632f
+  data.tar.gz: 9f699a8f91c817e1afd3ad0a53bfddf37c672755b0e58b9053199f4658c3dfdb
 SHA512:
-  metadata.gz: 3ba4cb7223cf9442f7ec90a11017c8b0119ee8109b27f047b505beb2e73ec358c4fd66816c249d6b3cb8c7eb6f16a81a196ec684714768ed08bbc35812ab70b4
-  data.tar.gz: 6e3052cc8ea47e1a41a9596593062119145d35b49450d74e66354c435664d624ff97db9cc8d5145d31c333e8af38b1845cdc7e03d955b7915282f5cc1dde3ba5
+  metadata.gz: aa12245be5a95e4c6075ca55dd77d99490689d9bf92ae78a1f6d46e7d4f1a107aa691b63648d62512a3db13e82be478bbdde13e22bd7398da6da726b824f0469
+  data.tar.gz: 7e0a0456830d495f00399615413a17b7cf9fb50089ed1f7000e6d3ad65be8c301c593de568a5356715904c713214e181dcc126c05ee381e0dee7fc9afc5bb923

data/README.md

@@ -5,18 +5,25 @@ This is a simplified variant of showing comments and source code.
 
 It is based on John Mair's (banisterfiend) gem called _method_source_.
 
-The gem is fine - however had I found that I only required MRI support
-for my own gems since that is what I am using.
+That gem is perfectly fine - however had, I found that I only required
+MRI support for my own gems since that is what I am using, so the
+code for other platforms was removed. Please refer to the original
+gem if you need support for these platforms - this here is mostly a
+stripped down variant.
 
-Thus, a lot of the code was not useful for me since it would be based
-on jruby or rubinius or also ruby 1.8. Hence why I stripped down and
-put it into a separate gem.
+I have also changed the code a bit more to my personal style to make
+it easier to work with.
 
-Credit where credit is due and in this case it was banisterfiend's
-initial work.
+Credit where credit is due - in this case the initial work was done on
+the gem method_source.
 
-The license is thus the MIT license. Please refer to his gem called
-method_source for a description of that gem.
+The license is thus the MIT license, as specified in the original variant
+of the gem "method_source", which is retained here. Please refer to that
+gem called method_source for a description of that gem.
+
+The aim of method_introspection is similar but not as big in scope - it's
+essentially just a stripped down variant essentially and allows us to
+inspect ruby methods at runtime.
 
 _Introspect ruby methods at runtime_
 

data/lib/method_introspection/code_helpers.rb

@@ -1,7 +1,67 @@
+#!/System/Index/bin/ruby -w
+# Encoding: ISO-8859-1
+# frozen_string_literal: true
+# =========================================================================== #
 module MethodIntrospection
 
 module CodeHelpers
 
+  # ========================================================================= #
+  # === extract_last_comment
+  #
+  # Get the last comment from the input. We will build up the result.
+  #
+  # @param [Array<String>]  lines
+  # @return [String]
+  # ========================================================================= #
+  def extract_last_comment(lines)
+    result = ''
+    lines.each { |line|
+      # ===================================================================== #
+      # Add any line that is a valid ruby comment but stop the moment
+      # we hit a non-comment line.
+      # ===================================================================== #
+      if (line =~ /^\s*#/) || (line =~ /^\s*$/)
+        # =================================================================== #
+        # Append onto result next. In the past we called .lstrip() here but
+        # this is no longer legal as we modify the original comment.
+        # =================================================================== #
+        result << line
+      else
+        result.replace("")
+      end
+    }
+    return result
+  end; private :extract_last_comment
+
+  # ========================================================================= #
+  # === comment_describing
+  #
+  # This method will retrieve the comment describing the expression on the
+  # given line of the given file.
+  #
+  # This is useful to get the module or method documentation, in String
+  # format.
+  #
+  # @param [Array<String>, File, String] file  The file to parse, either as a File or as
+  #                                            a String or an Array of lines.
+  # @param [Fixnum]  line_number  The line number at which to look.
+  #                             NOTE: The first line in a file is line 1!
+  # @return [String]  The comment
+  # ========================================================================= #
+  def comment_describing(file, line_number)
+    if file.is_a? Array
+      lines = file
+    else
+      lines = file.each_line.to_a
+    end
+    # ======================================================================= #
+    # At this point, lines is now an Array. We extract the proper lines
+    # by making use of the line number.
+    # ======================================================================= #
+    extract_last_comment(lines[0..(line_number - 2)])
+  end
+
   # ========================================================================= #
   # === expression_at
   #
@@ -10,12 +70,15 @@ module CodeHelpers
   #
   # This is useful to get module or method source code.
   #
-  # @param [Array<String>, File, String] file  The file to parse, either as a File or as
+  # @param [Array<String>, File, String] file  The file to parse, either as
+  # a File or as
+  #
   # @param [Fixnum]  line_number  The line number at which to look.
   #                             NOTE: The first line in a file is
   #                           line 1!
   #
   # @param [Hash] options The optional configuration parameters.
+  #
   # @option options [Boolean] :strict  If set to true, then only completely
   #   valid expressions are returned. Otherwise heuristics are used to extract
   #   expressions that may have been valid inside an eval.
@@ -40,11 +103,9 @@ module CodeHelpers
     else
       lines = file.each_line.to_a
     end
-
     relevant_lines = lines[(line_number - 1)..-1] || []
-
     extract_first_expression(relevant_lines, options[:consume])
-    rescue SyntaxError => e
+  rescue SyntaxError => e
     raise if options[:strict]
     begin
       extract_first_expression(relevant_lines) { |code|
@@ -55,42 +116,20 @@ module CodeHelpers
     end
   end
 
-  # ========================================================================= #
-  # === comment_describing
-  #
-  # This method will retrieve the comment describing the expression on the
-  # given line of the given file.
-  #
-  # This is useful to get the module or method documentation, in String
-  # format.
-  #
-  # @param [Array<String>, File, String] file  The file to parse, either as a File or as
-  #                                            a String or an Array of lines.
-  # @param [Fixnum]  line_number  The line number at which to look.
-  #                             NOTE: The first line in a file is line 1!
-  # @return [String]  The comment
-  # ========================================================================= #
-  def comment_describing(file, line_number)
-    if file.is_a? Array
-      lines = file
-    else
-      lines = file.each_line.to_a
-    end
-    extract_last_comment(lines[0..(line_number - 2)])
-  end
-
   # ========================================================================= #
   # === complete_expression?
   #
   # Determine if a string of code is a complete Ruby expression.
   #
-  # @param [String] code The code to validate.
-  # @return [Boolean] Whether or not the code is a complete Ruby expression.
-  # @raise [SyntaxError] Any SyntaxError that does not represent incompleteness.
-  # @example
-  #   complete_expression?("class Hello") #=> false
-  #   complete_expression?("class Hello; end") #=> true
-  #   complete_expression?("class 123") #=> SyntaxError: unexpected tINTEGER
+  # @param  [String]      code The code to validate.
+  # @return [Boolean]     Whether or not the code is a complete Ruby expression.
+  # @raise  [SyntaxError] Any SyntaxError that does not represent incompleteness.
+  #
+  # @Usage examples
+  #
+  #   complete_expression?("class Hello")      # => false
+  #   complete_expression?("class Hello; end") # => true
+  #   complete_expression?("class 123")        # => SyntaxError: unexpected tINTEGER
   # ========================================================================= #
   def complete_expression?(i)
     old_verbose = $VERBOSE
@@ -103,10 +142,9 @@ module CodeHelpers
   rescue IncompleteExpression
     false
   ensure
-    $VERBOSE = old_verbose
+    $VERBOSE = old_verbose # Reinstate the old verbosity level here.
   end
 
-  private
   # ========================================================================= #
   # === extract_first_expression
   #
@@ -126,45 +164,24 @@ module CodeHelpers
       return code if complete_expression?(block ? block.call(code) : code)
     }
     raise SyntaxError, "unexpected $end"
-  end
-
-  # ========================================================================= #
-  # === extract_last_comment
-  #
-  # Get the last comment from the input. We will build up the result.
-  #
-  # @param [Array<String>]  lines
-  # @return [String]
-  # ========================================================================= #
-  def extract_last_comment(lines)
-    result = ''
-    lines.each { |line|
-      # ===================================================================== #
-      # Add any line that is a valid ruby comment but stop the moment
-      # we hit a non-comment line.
-      # ===================================================================== #
-      if (line =~ /^\s*#/) || (line =~ /^\s*$/)
-        result << line.lstrip
-      else
-        result.replace("")
-      end
-    }
-    return result
-  end
+  end; private :extract_first_expression
 
   # ========================================================================= #
   # === IncompleteExpression
   #
-  # An exception matcher that matches only subsets of SyntaxErrors that can be
-  # fixed by adding more input to the buffer.
+  # IncompleteExpression is an exception matcher that matches only subsets
+  # of SyntaxErrors that can be fixed by adding more input to the buffer.
   # ========================================================================= #
   module IncompleteExpression
+    # ======================================================================= #
+    # === GENERIC_REGEXPS
+    #
+    # We only have to handle MRI.
+    # ======================================================================= #
     GENERIC_REGEXPS = [
-      /unexpected (\$end|end-of-file|end-of-input|END_OF_FILE)/, # mri, jruby, ruby-2.0, ironruby
+      /unexpected (\$end|end-of-file|end-of-input|END_OF_FILE)/, # mri
       /embedded document meets end of file/, # =begin
-      /unterminated (quoted string|string|regexp) meets end of file/, # "quoted string" is ironruby
-      /can not find the string ".*" anywhere before EOF/, # rbx and jruby
-      /missing 'end' for/, /expecting kWHEN/ # rbx
+      /unterminated (string|regexp) meets end of file/
     ]
     # ======================================================================= #
     # === IncompleteExpression.===

data/lib/method_introspection/load_project.rb

@@ -1,23 +1,21 @@
-module MethodIntrospection # require 'method_source/project_base_directory.rb'
+#!/System/Index/bin/ruby -w
+# Encoding: ISO-8859-1
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'method_introspection/load_project.rb'
+# =========================================================================== #
+require 'method_introspection/project/project_base_directory.rb'
 
-  # ========================================================================= #
-  # === PROJECT_BASE_DIRECTORY
-  # ========================================================================= #
-  PROJECT_BASE_DIRECTORY = RbConfig::CONFIG['sitelibdir']+'/method_introspection/'
-
-  # ========================================================================= #
-  # === MethodIntrospection.project_base_dir?
-  # ========================================================================= #
-  def self.project_base_dir?
-    PROJECT_BASE_DIRECTORY
-  end
+module MethodIntrospection
 
   # ========================================================================= #
-  # Next we load up the various .rb files of that project.
+  # Next, we load up the various .rb files of that project.
   # ========================================================================= #
-  require MethodIntrospection.project_base_dir?+'version/version.rb'
-  require MethodIntrospection.project_base_dir?+'source_location'
-  require MethodIntrospection.project_base_dir?+'code_helpers'
-  require MethodIntrospection.project_base_dir?+'module_methods'
+  _ = MethodIntrospection.project_base_dir?
+  require _+'version/version.rb'
+  require _+'module_methods.rb'
+  require _+'proc_extensions.rb'
+  require _+'code_helpers.rb'
+  require _+'source_location.rb'
 
 end

data/lib/method_introspection/module_methods.rb

@@ -1,9 +1,29 @@
 require 'pp'
+require 'method_introspection/source_not_found_error.rb'
+require 'method_introspection/module_instance_variables.rb'
 
 module MethodIntrospection # The top namespace of this project.
 
-  @this_file   = nil
-  @line_number = nil
+  # ========================================================================= #
+  # === MethodIntrospection.toggle_debug
+  # ========================================================================= #
+  def self.toggle_debug
+    @debug = !@debug
+  end
+
+  # ========================================================================= #
+  # === MethodIntrospection.debug?
+  # ========================================================================= #
+  def self.debug?
+    @debug
+  end
+
+  # ========================================================================= #
+  # === MethodIntrospection.enable_debug
+  # ========================================================================= #
+  def self.enable_debug
+    @debug = true
+  end
 
   # ========================================================================= #
   # === MethodIntrospection.set_this_file
@@ -33,18 +53,11 @@ module MethodIntrospection # The top namespace of this project.
     @line_number
   end
 
-  # ========================================================================= #
-  # === SourceNotFoundError
-  #
-  # An Exception to mark errors that were raised trying to find the
-  # source from a given source_location.
-  # ========================================================================= #
-  class SourceNotFoundError < StandardError; end
-
   # ========================================================================= #
   # === MethodIntrospection.raise_this
   #
-  # Second argument is optional, and allows for a longer description.
+  # The second argument to this method is optional, and allows for a
+  # longer description for the error message at hand.
   # ========================================================================= #
   def self.raise_this(name, optional_extra = nil)
     result = "We could not locate the source for #{name}"
@@ -63,14 +76,22 @@ module MethodIntrospection # The top namespace of this project.
   #
   # This is defined here to avoid polluting the `Method` class.
   #
-  # @param [Array] source_location The array returned by Method#source_location
-  # @param [String]  method_name
-  # @return [String] The method body
+  #   @param [Array]   source_location The array returned by Method#source_location
+  #   @param [String]  method_name
+  #   @return [String] The method body
   # ========================================================================= #
   def self.source_helper(source_location, name = nil)
     raise_this(name) unless source_location
-    file, line = *source_location
-    expression_at(lines_for(file), line)
+    this_file, line_number = *source_location
+    # ======================================================================= #
+    # Set the file.
+    # ======================================================================= #
+    MethodIntrospection.set_this_file(this_file)
+    # ======================================================================= #
+    # Set the line number in that file.
+    # ======================================================================= #
+    MethodIntrospection.set_line_number(line_number)
+    expression_at(lines_for(this_file), line_number)
   rescue SyntaxError => error
     raise SourceNotFoundError,
       "Could not parse source for #{name}: #{error.message}"
@@ -96,18 +117,19 @@ module MethodIntrospection # The top namespace of this project.
   # ========================================================================= #
   # === MethodIntrospection.comment_helper
   #
-  # Helper method responsible for opening source file and buffering up
-  # the comments for a specified method. Defined here to avoid 
-  # polluting the `Method` class.
+  # This is a helper method responsible for opening source file and
+  # buffering up the comments for a specified method. It is defined here
+  # to avoid polluting the `Method` class.
   #
   # The expected input should be an Array, which is returned by the
   # method Method#source_location.
   #
   # This will typically be in the form of:
   #
-  #  ["/Programs/Ruby/2.2.3/lib/ruby/site_ruby/2.2.0/config.rb", 297]
+  #   ["/Programs/Ruby/2.2.3/lib/ruby/site_ruby/2.2.0/config.rb", 297]
   #
-  # The first one yields to us the name, the second the line number.
+  # The first one yields to us the name of the file in question, and the
+  # second gives us the specific line number.
   #
   # @param [String]  method_name
   # @return [String] The comments up to the point of the method.
@@ -115,12 +137,17 @@ module MethodIntrospection # The top namespace of this project.
   def self.comment_helper(source_location, name = nil)
     raise_this(name) unless source_location
     this_file, line_number = *source_location
-pp source_location
-pp this_file
-pp line_number
     MethodIntrospection.set_this_file(this_file)
     MethodIntrospection.set_line_number(line_number)
-    comment_describing(lines_for(this_file), line_number)
+    # ======================================================================= #
+    # Next, we extract all the lines of a given file. lines will thus be a
+    # very big Array if we have a big file.
+    # ======================================================================= #
+    lines = lines_for(this_file)
+    # ======================================================================= #
+    # Next tap into comment_describing(). This resides in code_helpers.rb
+    # ======================================================================= #
+    comment_describing(lines, line_number)
   end
 
 end

data/lib/method_introspection/source_location.rb

@@ -1,6 +1,7 @@
 module MethodIntrospection
   module SourceLocation
     module MethodExtensions
+
       # ===================================================================== #
       # === trace_func
       # ===================================================================== #
@@ -12,23 +13,9 @@ module MethodIntrospection
       end; private :trace_func
     end
 
-    module ProcExtensions
-      # ===================================================================== #
-      # === source_location
-      #
-      # Return the source location for a Proc (in implementations
-      # without Proc#source_location)
-      #
-      # @return [Array] A two element array. First element is the
-      #   file, second element is the line in the file where the
-      #   proc definition is found.
-      # ===================================================================== #
-      def source_location
-        self.to_s =~ /@(.*):(\d+)/
-        [$1, $2.to_i]
-      end
-    end
-
+    # ======================================================================= #
+    # === UnboundMethodExtensions
+    # ======================================================================= #
     module UnboundMethodExtensions
       # ===================================================================== #
       # === source_location

data/lib/method_introspection/version/version.rb

@@ -1,5 +1,12 @@
+#!/System/Index/bin/ruby -w
+# Encoding: ISO-8859-1
+# frozen_string_literal: true
+# =========================================================================== #
 module MethodIntrospection
 
-  VERSION = '0.0.2'
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.0.11'
 
-end
+end

data/lib/method_introspection.rb

@@ -1,58 +1,9 @@
 require 'method_introspection/load_project.rb'
+require 'method_introspection/method.rb'
+require 'method_introspection/unbound_method.rb'
 
 module MethodIntrospection
 
   extend MethodIntrospection::CodeHelpers
 
-  # This module is to be included by `Method` and `UnboundMethod` and
-  # provides the `#source` functionality
-  module MethodExtensions
-    # === source
-    #
-    # The method source() will return the sourcecode for the method as
-    # a String.
-    #
-    # @return [String] The method sourcecode as a string
-    # @raise SourceNotFoundException
-    #
-    # @example
-    #  Set.instance_method(:clear).source.display
-    #  =>
-    #     def clear
-    #       @hash.clear
-    #       self
-    #     end
-    def source
-      MethodIntrospection.source_helper(source_location, defined?(name) ? name : inspect)
-    end
-
-    # === comment
-    #
-    # Return the comments associated with the method as a string.
-    # @return [String] The method's comments as a string
-    # @raise SourceNotFoundException
-    #
-    # @example
-    #  Set.instance_method(:clear).comment.display
-    #  =>
-    #     # Removes all elements and returns self.
-    def comment
-      MethodIntrospection.comment_helper(source_location, defined?(name) ? name : inspect)
-    end
-  end
-end
-
-class Method
-  include MethodIntrospection::SourceLocation::MethodExtensions
-  include MethodIntrospection::MethodExtensions
-end
-
-class UnboundMethod
-  include MethodIntrospection::SourceLocation::UnboundMethodExtensions
-  include MethodIntrospection::MethodExtensions
-end
-
-class Proc
-  include MethodIntrospection::SourceLocation::ProcExtensions
-  include MethodIntrospection::MethodExtensions
 end

data/method_introspection.gemspec

@@ -1,13 +1,14 @@
 # -*- encoding: utf-8 -*-
 require 'method_introspection/version/version.rb'
 
-DESCRIPTION = 'Allows us to inspect the source code for a method and the documentation.'
+DESCRIPTION = 'This gem allows us to inspect the source code '\
+              'for a method and the documentation.'
 
 Gem::Specification.new { |s|
   s.name    = 'method_introspection'
   s.version = MethodIntrospection::VERSION
 
-  s.authors = ['Robert A. Heiler']
+  s.authors = %w( Robert A. Heiler )
   s.date    = Time.now.strftime('%Y-%m-%d')
   s.email   = 'shevegen@gmail.com'
   s.files   = %w(
@@ -34,7 +35,8 @@ Gem::Specification.new { |s|
     'test/test_helper.rb'
   ]
 
-  s.required_ruby_version = '>= 2.2.2'
-  s.rubygems_version = '2.4.8'
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
 
 }

data/test/test.rb

@@ -1,11 +1,8 @@
-direc = File.expand_path(File.dirname(__FILE__))
-
-require 'rubygems'
 require 'bacon'
-require 'method_introspection/method_source.rb'
-require "#{direc}/test_helper"
+require 'method_introspection'
+require_relative './test_helper.rb'
 
-describe MethodIntrospection do
+describe MethodIntrospection {
 
   describe "source_location (testing 1.8 implementation)" do
     it 'should return correct source_location for a method' do
@@ -135,4 +132,4 @@ describe MethodIntrospection do
       method(:comment_test5).comment.should == @comment5
     end
   end
-end
+}

metadata

@@ -1,16 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: method_introspection
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.11
 platform: ruby
 authors:
-- Robert A. Heiler
+- Robert
+- A.
+- Heiler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies: []
-description: Allows us to inspect the source code for a method and the documentation.
+description: This gem allows us to inspect the source code for a method and the documentation.
 email: shevegen@gmail.com
 executables: []
 extensions: []
@@ -39,18 +41,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: Allows us to inspect the source code for a method and the documentation.
+summary: This gem allows us to inspect the source code for a method and the documentation.
 test_files:
 - test/test.rb
 - test/test_code_helpers.rb