method_introspection 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8e37158912e43ca147a709371c78620db8933fb
-  data.tar.gz: f1e14b2af4e5a389b52020a0bd0b64f6da5e021e
+  metadata.gz: 5568e7b6d6019161fe15bc2d2e2b1a8fab014096
+  data.tar.gz: 8908d1e7888d9189d4b4b3f0a8183e8df75affe8
 SHA512:
-  metadata.gz: 3ba4cb7223cf9442f7ec90a11017c8b0119ee8109b27f047b505beb2e73ec358c4fd66816c249d6b3cb8c7eb6f16a81a196ec684714768ed08bbc35812ab70b4
-  data.tar.gz: 6e3052cc8ea47e1a41a9596593062119145d35b49450d74e66354c435664d624ff97db9cc8d5145d31c333e8af38b1845cdc7e03d955b7915282f5cc1dde3ba5
+  metadata.gz: f951b118a85c7b0bd7922ae0398c4024e82f681739054b539b6a83cd13168644239355fdf949a958d4a6d63cd82bb9a0013c649fe25a1f14b4ce5132f166cdc4
+  data.tar.gz: 97612912cfa8e08264333f83e92baba4bae9fd1acab912b8e1647adf8e0a14cf80845408d6f5bfaaf704e182193bf57ef4eb4aca4375c6fc8cf971bcb6fd5431

data/lib/method_introspection/code_helpers.rb

@@ -2,6 +2,62 @@ 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
   #
@@ -55,30 +111,6 @@ 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?
   #
@@ -87,10 +119,12 @@ module CodeHelpers
   # @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
+  #
+  # @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 +137,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,39 +159,18 @@ 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
+    # ======================================================================= #
     GENERIC_REGEXPS = [
       /unexpected (\$end|end-of-file|end-of-input|END_OF_FILE)/, # mri, jruby, ruby-2.0, ironruby
       /embedded document meets end of file/, # =begin

data/lib/method_introspection/module_methods.rb

@@ -44,7 +44,8 @@ module MethodIntrospection # The top namespace of this project.
   # ========================================================================= #
   # === 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 of the error at hand.
   # ========================================================================= #
   def self.raise_this(name, optional_extra = nil)
     result = "We could not locate the source for #{name}"
@@ -63,14 +64,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 +105,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 +125,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

@@ -16,8 +16,8 @@ module MethodIntrospection
       # ===================================================================== #
       # === source_location
       #
-      # Return the source location for a Proc (in implementations
-      # without Proc#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

data/lib/method_introspection/version/version.rb

@@ -1,5 +1,5 @@
 module MethodIntrospection
 
-  VERSION = '0.0.2'
+  VERSION = '0.0.6'
 
 end

data/lib/method_introspection.rb

@@ -4,9 +4,13 @@ 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
@@ -22,10 +26,14 @@ module MethodIntrospection
     #       @hash.clear
     #       self
     #     end
+    # ======================================================================= #
     def source
-      MethodIntrospection.source_helper(source_location, defined?(name) ? name : inspect)
-    end
+      MethodIntrospection.source_helper(
+        source_location, defined?(name) ? name : inspect
+      )
+    end; alias source? source
 
+    # ======================================================================= #
     # === comment
     #
     # Return the comments associated with the method as a string.
@@ -36,6 +44,7 @@ module MethodIntrospection
     #  Set.instance_method(:clear).comment.display
     #  =>
     #     # Removes all elements and returns self.
+    # ======================================================================= #
     def comment
       MethodIntrospection.comment_helper(source_location, defined?(name) ? name : inspect)
     end

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: method_introspection
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - Robert A. Heiler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-09-19 00:00:00.000000000 Z
 dependencies: []
 description: Allows us to inspect the source code for a method and the documentation.
 email: shevegen@gmail.com
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Allows us to inspect the source code for a method and the documentation.