method_introspection 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a281ed170dd1e993975cc0cdd4ea889caa72a286
-  data.tar.gz: e3916ce0e0c21b1f2ef4fe2006e5bf5f5676b41c
+  metadata.gz: f8e37158912e43ca147a709371c78620db8933fb
+  data.tar.gz: f1e14b2af4e5a389b52020a0bd0b64f6da5e021e
 SHA512:
-  metadata.gz: a38dca730b231aa479f30b2ffb65ed0ef62236cef7786ed95d5f0f616da9360a765f86509cd2a59e952d5b11387baf037059805a90584a653909b348767241d6
-  data.tar.gz: 13857fafe0c960a482abb0612406fb0782df8572a9c3c7f34c9a1fc665e77a7e95b841f3f7f8d8214c6714997815d94f9156255a14ee04b522c17b04ec5f8abc
+  metadata.gz: 3ba4cb7223cf9442f7ec90a11017c8b0119ee8109b27f047b505beb2e73ec358c4fd66816c249d6b3cb8c7eb6f16a81a196ec684714768ed08bbc35812ab70b4
+  data.tar.gz: 6e3052cc8ea47e1a41a9596593062119145d35b49450d74e66354c435664d624ff97db9cc8d5145d31c333e8af38b1845cdc7e03d955b7915282f5cc1dde3ba5

data/lib/method_introspection/code_helpers.rb

@@ -22,7 +22,8 @@ module CodeHelpers
   # @option options [Fixnum] :consume  A number of lines to automatically
   #   consume (add to the expression buffer) without checking for validity.
   # @return [String]  The first complete expression
-  # @raise [SyntaxError]  If the first complete expression can't be identified
+  #
+  # @raise [SyntaxError] If the first complete expression can't be identified
   # ========================================================================= #
   def expression_at(
       file,
@@ -45,7 +46,6 @@ module CodeHelpers
     extract_first_expression(relevant_lines, options[:consume])
     rescue SyntaxError => e
     raise if options[:strict]
-
     begin
       extract_first_expression(relevant_lines) { |code|
         code.gsub(/\#\{.*?\}/, "temp")
@@ -58,10 +58,11 @@ module CodeHelpers
   # ========================================================================= #
   # === comment_describing
   #
-  # Retrieve the comment describing the expression on the given line of
-  # the given file.
+  # This method will retrieve the comment describing the expression on the
+  # given line of the given file.
   #
-  # This is useful to get module or method documentation.
+  # 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.
@@ -70,7 +71,11 @@ module CodeHelpers
   # @return [String]  The comment
   # ========================================================================= #
   def comment_describing(file, line_number)
-    lines = file.is_a?(Array) ? file : file.each_line.to_a
+    if file.is_a? Array
+      lines = file
+    else
+      lines = file.each_line.to_a
+    end
     extract_last_comment(lines[0..(line_number - 2)])
   end
 
@@ -102,7 +107,6 @@ module CodeHelpers
   end
 
   private
-
   # ========================================================================= #
   # === extract_first_expression
   #
@@ -127,7 +131,7 @@ module CodeHelpers
   # ========================================================================= #
   # === extract_last_comment
   #
-  # Get the last comment from the input.
+  # Get the last comment from the input. We will build up the result.
   #
   # @param [Array<String>]  lines
   # @return [String]
@@ -162,10 +166,12 @@ module CodeHelpers
       /can not find the string ".*" anywhere before EOF/, # rbx and jruby
       /missing 'end' for/, /expecting kWHEN/ # rbx
     ]
-
-    def self.===(ex)
-      return false unless SyntaxError === ex
-      case ex.message
+    # ======================================================================= #
+    # === IncompleteExpression.===
+    # ======================================================================= #
+    def self.===(exception)
+      return false unless SyntaxError === exception
+      case exception.message
       when *GENERIC_REGEXPS
         true
       else

data/lib/method_introspection/module_methods.rb

@@ -1,4 +1,37 @@
-module MethodIntrospection
+require 'pp'
+
+module MethodIntrospection # The top namespace of this project.
+
+  @this_file   = nil
+  @line_number = nil
+
+  # ========================================================================= #
+  # === MethodIntrospection.set_this_file
+  # ========================================================================= #
+  def self.set_this_file(i) # setter
+    @this_file = i
+  end
+
+  # ========================================================================= #
+  # === MethodIntrospection.this_file?
+  # ========================================================================= #
+  def self.this_file?
+    @this_file
+  end; self.instance_eval { alias file? this_file? } # === MethodIntrospection.file?
+
+  # ========================================================================= #
+  # === MethodIntrospection.set_line_number
+  # ========================================================================= #
+  def self.set_line_number(i) # setter
+    @line_number = i
+  end
+
+  # ========================================================================= #
+  # === MethodIntrospection.line_number?
+  # ========================================================================= #
+  def self.line_number?
+    @line_number
+  end
 
   # ========================================================================= #
   # === SourceNotFoundError
@@ -28,7 +61,8 @@ module MethodIntrospection
   #
   # Helper method responsible for extracting the body of a method.
   #
-  # Defined here to avoid polluting `Method` class.
+  # 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
@@ -42,22 +76,6 @@ module MethodIntrospection
       "Could not parse source for #{name}: #{error.message}"
   end
 
-  # ========================================================================= #
-  # === MethodIntrospection.comment_helper
-  #
-  # Helper method responsible for opening source file and buffering up
-  # the comments for a specified method. Defined here to avoid polluting
-  # `Method` class.
-  # @param [Array] source_location The array returned by Method#source_location
-  # @param [String]  method_name
-  # @return [String] The comments up to the point of the method.
-  # ========================================================================= #
-  def self.comment_helper(source_location, name = nil)
-    raise_this(name) unless source_location
-    file, line = *source_location
-    comment_describing(lines_for(file), line)
-  end
-
   # ========================================================================= #
   # === MethodIntrospection.lines_for
   #
@@ -75,4 +93,34 @@ module MethodIntrospection
     raise_this(name, e.message)
   end
 
+  # ========================================================================= #
+  # === 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.
+  #
+  # 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]
+  #
+  # The first one yields to us the name, the second the line number.
+  #
+  # @param [String]  method_name
+  # @return [String] The comments up to the point of the method.
+  # ========================================================================= #
+  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)
+  end
+
 end

data/lib/method_introspection/source_location.rb

@@ -13,12 +13,16 @@ module MethodIntrospection
     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]
@@ -26,21 +30,28 @@ module MethodIntrospection
     end
 
     module UnboundMethodExtensions
+      # ===================================================================== #
+      # === source_location
+      #
       # Return the source location of an instance method for Ruby 1.8.
       #
       # @return [Array] A two element array. First element is the
       #   file, second element is the line in the file where the
       #   method definition is found.
+      # ===================================================================== #
       def source_location
-        klass = case owner
-                when Class
-                  owner
-                when Module
-                  method_owner = owner
-                  Class.new { include(method_owner) }
-                end
+        klass =
+        case owner
+        when Class
+          owner
+        when Module
+          method_owner = owner
+          Class.new { include(method_owner) }
+        end
 
-        # deal with immediate values
+        # =================================================================== #
+        # Deal with immediate values.
+        # =================================================================== #
         case
         when klass == Symbol
           return :a.method(name).source_location

data/lib/method_introspection/version/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_introspection
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert A. Heiler